Class: AWS.Chime

Inherits:
AWS.Service show all
Identifier:
chime
API Version:
2018-05-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST API

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console in the Amazon Chime Administration Guide.

Sending a Request Using Chime

var chime = new AWS.Chime();
chime.associatePhoneNumberWithUser(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Chime object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var chime = new AWS.Chime({apiVersion: '2018-05-01'});

You can also set the API version globally in AWS.config.apiVersions using the chime service identifier:

AWS.config.apiVersions = {
  chime: '2018-05-01',
  // other service API versions
};

var chime = new AWS.Chime();

Version:

  • 2018-05-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Chime(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Chime object

var chime = new AWS.Chime({apiVersion: '2018-05-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Chime.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Chime.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Chime.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associatePhoneNumbersWithVoiceConnector(params = {}, callback) ⇒ AWS.Request

Associates a phone number with the specified Amazon Chime Voice Connector.

Examples:

Calling the associatePhoneNumbersWithVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  E164PhoneNumbers: [
    'STRING_VALUE',
    /* more items */
  ]
};
chime.associatePhoneNumbersWithVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associatePhoneNumberWithUser(params = {}, callback) ⇒ AWS.Request

Associates a phone number with the specified Amazon Chime user.

Service Reference:

Examples:

Calling the associatePhoneNumberWithUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  E164PhoneNumber: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.associatePhoneNumberWithUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

    • E164PhoneNumber — (String)

      The phone number, in E.164 format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDeletePhoneNumber(params = {}, callback) ⇒ AWS.Request

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Service Reference:

Examples:

Calling the batchDeletePhoneNumber operation

var params = {
  PhoneNumberIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.batchDeletePhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneNumberIds — (Array<String>)

      List of phone number IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchSuspendUser(params = {}, callback) ⇒ AWS.Request

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

Service Reference:

Examples:

Calling the batchSuspendUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserIdList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.batchSuspendUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserIdList — (Array<String>)

      The request containing the user IDs to suspend.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UserErrors — (Array<map>)

        If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

        • UserId — (String)

          The user ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchUnsuspendUser(params = {}, callback) ⇒ AWS.Request

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

Service Reference:

Examples:

Calling the batchUnsuspendUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserIdList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.batchUnsuspendUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserIdList — (Array<String>)

      The request containing the user IDs to unsuspend.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UserErrors — (Array<map>)

        If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

        • UserId — (String)

          The user ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchUpdatePhoneNumber(params = {}, callback) ⇒ AWS.Request

Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

Service Reference:

Examples:

Calling the batchUpdatePhoneNumber operation

var params = {
  UpdatePhoneNumberRequestItems: [ /* required */
    {
      PhoneNumberId: 'STRING_VALUE', /* required */
      ProductType: BusinessCalling | VoiceConnector
    },
    /* more items */
  ]
};
chime.batchUpdatePhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UpdatePhoneNumberRequestItems — (Array<map>)

      The request containing the phone number IDs and product types to update.

      • PhoneNumberIdrequired — (String)

        The phone number ID to update.

      • ProductType — (String)

        The product type to update.

        Possible values include:
        • "BusinessCalling"
        • "VoiceConnector"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchUpdateUser(params = {}, callback) ⇒ AWS.Request

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

Service Reference:

Examples:

Calling the batchUpdateUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UpdateUserRequestItems: [ /* required */
    {
      UserId: 'STRING_VALUE', /* required */
      LicenseType: Basic | Plus | Pro | ProTrial
    },
    /* more items */
  ]
};
chime.batchUpdateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UpdateUserRequestItems — (Array<map>)

      The request containing the user IDs and details to update.

      • UserIdrequired — (String)

        The user ID.

      • LicenseType — (String)

        The user license type.

        Possible values include:
        • "Basic"
        • "Plus"
        • "Pro"
        • "ProTrial"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UserErrors — (Array<map>)

        If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

        • UserId — (String)

          The user ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAccount(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Service Reference:

Examples:

Calling the createAccount operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
chime.createAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the Amazon Chime account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Account — (map)

        The Amazon Chime account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBot(params = {}, callback) ⇒ AWS.Request

Creates a bot for an Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the createBot operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE'
};
chime.createBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • DisplayName — (String)

      The bot display name.

    • Domain — (String)

      The domain of the Amazon Chime Enterprise account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Bot — (map)

        The bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPhoneNumberOrder(params = {}, callback) ⇒ AWS.Request

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

Service Reference:

Examples:

Calling the createPhoneNumberOrder operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ProductType: BusinessCalling | VoiceConnector /* required */
};
chime.createPhoneNumberOrder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProductType — (String)

      The phone number product type.

      Possible values include:
      • "BusinessCalling"
      • "VoiceConnector"
    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberOrder — (map)

        The phone number order details.

        • PhoneNumberOrderId — (String)

          The phone number order ID.

        • ProductType — (String)

          The phone number order product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
        • OrderedPhoneNumbers — (Array<map>)

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • E164PhoneNumber — (String)

            The phone number, in E.164 format.

          • Status — (String)

            The phone number status.

            Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)

          The phone number order creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createVoiceConnector(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

Service Reference:

Examples:

Calling the createVoiceConnector operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RequireEncryption: true || false /* required */
};
chime.createVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the Amazon Chime Voice Connector.

    • RequireEncryption — (Boolean)

      When enabled, requires encryption for the Amazon Chime Voice Connector.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector details.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAccount(params = {}, callback) ⇒ AWS.Request

Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

Service Reference:

Examples:

Calling the deleteAccount operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.deleteAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEventsConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the events configuration that allows a bot to receive outgoing events.

Service Reference:

Examples:

Calling the deleteEventsConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.deleteEventsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deletePhoneNumber(params = {}, callback) ⇒ AWS.Request

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Service Reference:

Examples:

Calling the deletePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chime.deletePhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneNumberId — (String)

      The phone number ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVoiceConnector(params = {}, callback) ⇒ AWS.Request

Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted.

Service Reference:

Examples:

Calling the deleteVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request

Deletes the origination settings for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the deleteVoiceConnectorOrigination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorOrigination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request

Deletes the termination settings for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the deleteVoiceConnectorTermination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorTermination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Examples:

Calling the deleteVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  Usernames: [
    'STRING_VALUE',
    /* more items */
  ]
};
chime.deleteVoiceConnectorTerminationCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Usernames — (Array<String>)

      The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociatePhoneNumberFromUser(params = {}, callback) ⇒ AWS.Request

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Service Reference:

Examples:

Calling the disassociatePhoneNumberFromUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.disassociatePhoneNumberFromUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociatePhoneNumbersFromVoiceConnector(params = {}, callback) ⇒ AWS.Request

Disassociates the specified phone number from the specified Amazon Chime Voice Connector.

Examples:

Calling the disassociatePhoneNumbersFromVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  E164PhoneNumbers: [
    'STRING_VALUE',
    /* more items */
  ]
};
chime.disassociatePhoneNumbersFromVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "Unauthorized"
          • "Forbidden"
          • "NotFound"
          • "BadRequest"
          • "Conflict"
          • "ServiceFailure"
          • "ServiceUnavailable"
          • "Unprocessable"
          • "Throttled"
          • "PreconditionFailed"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccount(params = {}, callback) ⇒ AWS.Request

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Service Reference:

Examples:

Calling the getAccount operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.getAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Account — (map)

        The Amazon Chime account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccountSettings(params = {}, callback) ⇒ AWS.Request

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Service Reference:

Examples:

Calling the getAccountSettings operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.getAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountSettings — (map)

        The Amazon Chime account settings.

        • DisableRemoteControl — (Boolean)

          Setting that stops or starts remote control of shared screens during meetings.

        • EnableDialOut — (Boolean)

          Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBot(params = {}, callback) ⇒ AWS.Request

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Service Reference:

Examples:

Calling the getBot operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.getBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Bot — (map)

        The chat bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEventsConfiguration(params = {}, callback) ⇒ AWS.Request

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

Service Reference:

Examples:

Calling the getEventsConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.getEventsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventsConfiguration — (map)

        The events configuration details.

        • BotId — (String)

          The bot ID.

        • OutboundEventsHTTPSEndpoint — (String)

          HTTPS endpoint that allows a bot to receive outgoing events.

        • LambdaFunctionArn — (String)

          Lambda function ARN that allows a bot to receive outgoing events.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGlobalSettings(params = {}, callback) ⇒ AWS.Request

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Service Reference:

Examples:

Calling the getGlobalSettings operation

chime.getGlobalSettings(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BusinessCalling — (map)

        The Amazon Chime Business Calling settings.

        • CdrBucket — (String)

          The Amazon S3 bucket designated for call detail record storage.

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector settings.

        • CdrBucket — (String)

          The Amazon S3 bucket designated for call detail record storage.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPhoneNumber(params = {}, callback) ⇒ AWS.Request

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Service Reference:

Examples:

Calling the getPhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chime.getPhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneNumberId — (String)

      The phone number ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumber — (map)

        The phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPhoneNumberOrder(params = {}, callback) ⇒ AWS.Request

Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.

Service Reference:

Examples:

Calling the getPhoneNumberOrder operation

var params = {
  PhoneNumberOrderId: 'STRING_VALUE' /* required */
};
chime.getPhoneNumberOrder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneNumberOrderId — (String)

      The ID for the phone number order.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberOrder — (map)

        The phone number order details.

        • PhoneNumberOrderId — (String)

          The phone number order ID.

        • ProductType — (String)

          The phone number order product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
        • OrderedPhoneNumbers — (Array<map>)

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • E164PhoneNumber — (String)

            The phone number, in E.164 format.

          • Status — (String)

            The phone number status.

            Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)

          The phone number order creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getUser(params = {}, callback) ⇒ AWS.Request

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

Service Reference:

Examples:

Calling the getUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.getUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • User — (map)

        The user details.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getUserSettings(params = {}, callback) ⇒ AWS.Request

Retrieves settings for the specified user ID, such as any associated phone number settings.

Service Reference:

Examples:

Calling the getUserSettings operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.getUserSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UserSettings — (map)

        The user settings.

        • Telephonyrequired — (map)

          The telephony settings associated with the user.

          • InboundCallingrequired — (Boolean)

            Allows or denies inbound calling.

          • OutboundCallingrequired — (Boolean)

            Allows or denies outbound calling.

          • SMSrequired — (Boolean)

            Allows or denies SMS messaging.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVoiceConnector(params = {}, callback) ⇒ AWS.Request

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.

Service Reference:

Examples:

Calling the getVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector details.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorOrigination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorOrigination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Origination — (map)

        The origination setting details.

        • Routes — (Array<map>)

          The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

          • Host — (String)

            The FODN or IP address to contact for origination traffic.

          • Port — (Integer)

            The designated origination route port. Defaults to 5060.

          • Protocol — (String)

            The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

            Possible values include:
            • "TCP"
            • "UDP"
          • Priority — (Integer)

            The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

          • Weight — (Integer)

            The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

        • Disabled — (Boolean)

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorTermination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorTermination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Termination — (map)

        The termination setting details.

        • CpsLimit — (Integer)

          The limit on calls per second. Max value based on account service limit. Default value of 1.

        • DefaultPhoneNumber — (String)

          The default caller ID phone number.

        • CallingRegions — (Array<String>)

          The countries to which calls are allowed.

        • CidrAllowedList — (Array<String>)

          The IP addresses allowed to make calls, in CIDR format.

        • Disabled — (Boolean)

          When termination settings are disabled, outbound calls can not be made.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVoiceConnectorTerminationHealth(params = {}, callback) ⇒ AWS.Request

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

Examples:

Calling the getVoiceConnectorTerminationHealth operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorTerminationHealth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TerminationHealth — (map)

        The termination health details.

        • Timestamp — (Date)

          The timestamp, in ISO 8601 format.

        • Source — (String)

          The source IP address.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

inviteUsers(params = {}, callback) ⇒ AWS.Request

Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Service Reference:

Examples:

Calling the inviteUsers operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserEmailList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.inviteUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserEmailList — (Array<String>)

      The user email addresses to which to send the invite.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Invites — (Array<map>)

        The invite details.

        • InviteId — (String)

          The invite ID.

        • Status — (String)

          The status of the invite.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • EmailAddress — (String)

          The email address to which the invite is sent.

        • EmailStatus — (String)

          The status of the invite email.

          Possible values include:
          • "NotSent"
          • "Sent"
          • "Failed"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAccounts(params = {}, callback) ⇒ AWS.Request

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

Service Reference:

Examples:

Calling the listAccounts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  UserEmail: 'STRING_VALUE'
};
chime.listAccounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      Amazon Chime account name prefix with which to filter results.

    • UserEmail — (String)

      User email address with which to filter results.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Defaults to 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Accounts — (Array<map>)

        List of Amazon Chime accounts and account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBots(params = {}, callback) ⇒ AWS.Request

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Service Reference:

Examples:

Calling the listBots operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listBots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Default is 10.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Bots — (Array<map>)

        List of bots and bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPhoneNumberOrders(params = {}, callback) ⇒ AWS.Request

Lists the phone number orders for the administrator's Amazon Chime account.

Service Reference:

Examples:

Calling the listPhoneNumberOrders operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listPhoneNumberOrders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The token to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumberOrders — (Array<map>)

        The phone number order details.

        • PhoneNumberOrderId — (String)

          The phone number order ID.

        • ProductType — (String)

          The phone number order product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
        • OrderedPhoneNumbers — (Array<map>)

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • E164PhoneNumber — (String)

            The phone number, in E.164 format.

          • Status — (String)

            The phone number status.

            Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)

          The phone number order creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPhoneNumbers(params = {}, callback) ⇒ AWS.Request

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the listPhoneNumbers operation

var params = {
  FilterName: AccountId | UserId | VoiceConnectorId,
  FilterValue: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProductType: BusinessCalling | VoiceConnector,
  Status: AcquireInProgress | AcquireFailed | Unassigned | Assigned | ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed
};
chime.listPhoneNumbers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Status — (String)

      The phone number status.

      Possible values include:
      • "AcquireInProgress"
      • "AcquireFailed"
      • "Unassigned"
      • "Assigned"
      • "ReleaseInProgress"
      • "DeleteInProgress"
      • "ReleaseFailed"
      • "DeleteFailed"
    • ProductType — (String)

      The phone number product type.

      Possible values include:
      • "BusinessCalling"
      • "VoiceConnector"
    • FilterName — (String)

      The filter to use to limit the number of results.

      Possible values include:
      • "AccountId"
      • "UserId"
      • "VoiceConnectorId"
    • FilterValue — (String)

      The value to use for the filter.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumbers — (Array<map>)

        The phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listUsers(params = {}, callback) ⇒ AWS.Request

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

Service Reference:

Examples:

Calling the listUsers operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  UserEmail: 'STRING_VALUE'
};
chime.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserEmail — (String)

      Optional. The user email address used to filter results. Maximum 1.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Defaults to 100.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Users — (Array<map>)

        List of users and user details.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVoiceConnectors(params = {}, callback) ⇒ AWS.Request

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Service Reference:

Examples:

Calling the listVoiceConnectors operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listVoiceConnectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The token to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceConnectors — (Array<map>)

        The details of the Amazon Chime Voice Connectors.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

Examples:

Calling the listVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.listVoiceConnectorTerminationCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Usernames — (Array<String>)

        A list of user names.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

logoutUser(params = {}, callback) ⇒ AWS.Request

Logs out the specified user from all of the devices they are currently logged into.

Service Reference:

Examples:

Calling the logoutUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.logoutUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putEventsConfiguration(params = {}, callback) ⇒ AWS.Request

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

Service Reference:

Examples:

Calling the putEventsConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE', /* required */
  LambdaFunctionArn: 'STRING_VALUE',
  OutboundEventsHTTPSEndpoint: 'STRING_VALUE'
};
chime.putEventsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

    • OutboundEventsHTTPSEndpoint — (String)

      HTTPS endpoint that allows the bot to receive outgoing events.

    • LambdaFunctionArn — (String)

      Lambda function ARN that allows the bot to receive outgoing events.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventsConfiguration — (map)

        The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

        • BotId — (String)

          The bot ID.

        • OutboundEventsHTTPSEndpoint — (String)

          HTTPS endpoint that allows a bot to receive outgoing events.

        • LambdaFunctionArn — (String)

          Lambda function ARN that allows a bot to receive outgoing events.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request

Adds origination settings for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the putVoiceConnectorOrigination operation

var params = {
  Origination: { /* required */
    Disabled: true || false,
    Routes: [
      {
        Host: 'STRING_VALUE',
        Port: 'NUMBER_VALUE',
        Priority: 'NUMBER_VALUE',
        Protocol: TCP | UDP,
        Weight: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorOrigination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Origination — (map)

      The origination setting details to add.

      • Routes — (Array<map>)

        The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

        • Host — (String)

          The FODN or IP address to contact for origination traffic.

        • Port — (Integer)

          The designated origination route port. Defaults to 5060.

        • Protocol — (String)

          The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

          Possible values include:
          • "TCP"
          • "UDP"
        • Priority — (Integer)

          The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

        • Weight — (Integer)

          The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

      • Disabled — (Boolean)

        When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Origination — (map)

        The updated origination setting details.

        • Routes — (Array<map>)

          The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

          • Host — (String)

            The FODN or IP address to contact for origination traffic.

          • Port — (Integer)

            The designated origination route port. Defaults to 5060.

          • Protocol — (String)

            The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

            Possible values include:
            • "TCP"
            • "UDP"
          • Priority — (Integer)

            The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

          • Weight — (Integer)

            The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

        • Disabled — (Boolean)

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request

Adds termination settings for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the putVoiceConnectorTermination operation

var params = {
  Termination: { /* required */
    CallingRegions: [
      'STRING_VALUE',
      /* more items */
    ],
    CidrAllowedList: [
      'STRING_VALUE',
      /* more items */
    ],
    CpsLimit: 'NUMBER_VALUE',
    DefaultPhoneNumber: 'STRING_VALUE',
    Disabled: true || false
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorTermination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Termination — (map)

      The termination setting details to add.

      • CpsLimit — (Integer)

        The limit on calls per second. Max value based on account service limit. Default value of 1.

      • DefaultPhoneNumber — (String)

        The default caller ID phone number.

      • CallingRegions — (Array<String>)

        The countries to which calls are allowed.

      • CidrAllowedList — (Array<String>)

        The IP addresses allowed to make calls, in CIDR format.

      • Disabled — (Boolean)

        When termination settings are disabled, outbound calls can not be made.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Termination — (map)

        The updated termination setting details.

        • CpsLimit — (Integer)

          The limit on calls per second. Max value based on account service limit. Default value of 1.

        • DefaultPhoneNumber — (String)

          The default caller ID phone number.

        • CallingRegions — (Array<String>)

          The countries to which calls are allowed.

        • CidrAllowedList — (Array<String>)

          The IP addresses allowed to make calls, in CIDR format.

        • Disabled — (Boolean)

          When termination settings are disabled, outbound calls can not be made.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Examples:

Calling the putVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  Credentials: [
    {
      Password: 'STRING_VALUE',
      Username: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chime.putVoiceConnectorTerminationCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Credentials — (Array<map>)

      The termination SIP credentials.

      • Username — (String)

        The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

      • Password — (String)

        The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

regenerateSecurityToken(params = {}, callback) ⇒ AWS.Request

Regenerates the security token for a bot.

Service Reference:

Examples:

Calling the regenerateSecurityToken operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.regenerateSecurityToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Bot — (map)

        A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resetPersonalPIN(params = {}, callback) ⇒ AWS.Request

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Service Reference:

Examples:

Calling the resetPersonalPIN operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.resetPersonalPIN(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • User — (map)

        The user details and new personal meeting PIN.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

restorePhoneNumber(params = {}, callback) ⇒ AWS.Request

Moves a phone number from the Deletion queue back into the phone number Inventory.

Service Reference:

Examples:

Calling the restorePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chime.restorePhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneNumberId — (String)

      The phone number.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumber — (map)

        The phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchAvailablePhoneNumbers(params = {}, callback) ⇒ AWS.Request

Searches phone numbers that can be ordered.

Service Reference:

Examples:

Calling the searchAvailablePhoneNumbers operation

var params = {
  AreaCode: 'STRING_VALUE',
  City: 'STRING_VALUE',
  Country: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  State: 'STRING_VALUE',
  TollFreePrefix: 'STRING_VALUE'
};
chime.searchAvailablePhoneNumbers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AreaCode — (String)

      The area code used to filter results.

    • City — (String)

      The city used to filter results.

    • Country — (String)

      The country used to filter results.

    • State — (String)

      The state used to filter results.

    • TollFreePrefix — (String)

      The toll-free prefix that you use to filter results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • E164PhoneNumbers — (Array<String>)

        List of phone numbers, in E.164 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAccount(params = {}, callback) ⇒ AWS.Request

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

Service Reference:

Examples:

Calling the updateAccount operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
chime.updateAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • Name — (String)

      The new name for the specified Amazon Chime account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Account — (map)

        The updated Amazon Chime account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAccountSettings(params = {}, callback) ⇒ AWS.Request

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Service Reference:

Examples:

Calling the updateAccountSettings operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  AccountSettings: { /* required */
    DisableRemoteControl: true || false,
    EnableDialOut: true || false
  }
};
chime.updateAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • AccountSettings — (map)

      The Amazon Chime account settings to update.

      • DisableRemoteControl — (Boolean)

        Setting that stops or starts remote control of shared screens during meetings.

      • EnableDialOut — (Boolean)

        Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateBot(params = {}, callback) ⇒ AWS.Request

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the updateBot operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE', /* required */
  Disabled: true || false
};
chime.updateBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

    • Disabled — (Boolean)

      When true, stops the specified bot from running in your account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Bot — (map)

        The updated bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGlobalSettings(params = {}, callback) ⇒ AWS.Request

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Service Reference:

Examples:

Calling the updateGlobalSettings operation

var params = {
  BusinessCalling: { /* required */
    CdrBucket: 'STRING_VALUE'
  },
  VoiceConnector: { /* required */
    CdrBucket: 'STRING_VALUE'
  }
};
chime.updateGlobalSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BusinessCalling — (map)

      The Amazon Chime Business Calling settings.

      • CdrBucket — (String)

        The Amazon S3 bucket designated for call detail record storage.

    • VoiceConnector — (map)

      The Amazon Chime Voice Connector settings.

      • CdrBucket — (String)

        The Amazon S3 bucket designated for call detail record storage.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updatePhoneNumber(params = {}, callback) ⇒ AWS.Request

Updates phone number details, such as product type, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

Service Reference:

Examples:

Calling the updatePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  ProductType: BusinessCalling | VoiceConnector
};
chime.updatePhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneNumberId — (String)

      The phone number ID.

    • ProductType — (String)

      The product type.

      Possible values include:
      • "BusinessCalling"
      • "VoiceConnector"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumber — (map)

        The updated phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateUser(params = {}, callback) ⇒ AWS.Request

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Service Reference:

Examples:

Calling the updateUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  LicenseType: Basic | Plus | Pro | ProTrial
};
chime.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

    • LicenseType — (String)

      The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

      Possible values include:
      • "Basic"
      • "Plus"
      • "Pro"
      • "ProTrial"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • User — (map)

        The updated user details.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateUserSettings(params = {}, callback) ⇒ AWS.Request

Updates the settings for the specified user, such as phone number settings.

Service Reference:

Examples:

Calling the updateUserSettings operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  UserSettings: { /* required */
    Telephony: { /* required */
      InboundCalling: true || false, /* required */
      OutboundCalling: true || false, /* required */
      SMS: true || false /* required */
    }
  }
};
chime.updateUserSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

    • UserSettings — (map)

      The user settings to update.

      • Telephonyrequired — (map)

        The telephony settings associated with the user.

        • InboundCallingrequired — (Boolean)

          Allows or denies inbound calling.

        • OutboundCallingrequired — (Boolean)

          Allows or denies outbound calling.

        • SMSrequired — (Boolean)

          Allows or denies SMS messaging.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateVoiceConnector(params = {}, callback) ⇒ AWS.Request

Updates details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the updateVoiceConnector operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RequireEncryption: true || false, /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.updateVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Name — (String)

      The name of the Amazon Chime Voice Connector.

    • RequireEncryption — (Boolean)

      When enabled, requires encryption for the Amazon Chime Voice Connector.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector details.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.