We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ChimeSDKVoice

Inherits:
AWS.Service show all
Identifier:
chimesdkvoice
API Version:
2022-08-03
Defined in:
(unknown)

Overview

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

Service Description

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

Sending a Request Using ChimeSDKVoice

var chimesdkvoice = new AWS.ChimeSDKVoice();
chimesdkvoice.associatePhoneNumbersWithVoiceConnector(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 ChimeSDKVoice object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var chimesdkvoice = new AWS.ChimeSDKVoice({apiVersion: '2022-08-03'});

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

AWS.config.apiVersions = {
  chimesdkvoice: '2022-08-03',
  // other service API versions
};

var chimesdkvoice = new AWS.ChimeSDKVoice();

Version:

  • 2022-08-03

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.ChimeSDKVoice(options = {}) ⇒ Object

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

Examples:

Constructing a ChimeSDKVoice object

var chimesdkvoice = new AWS.ChimeSDKVoice({apiVersion: '2022-08-03'});

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|AWS.Endpoint)

    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' or an Endpoint object.

  • 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.ChimeSDKVoice.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ChimeSDKVoice.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • 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'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

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 phone numbers with the specified Amazon Chime SDK Voice Connector.

Examples:

Calling the associatePhoneNumbersWithVoiceConnector operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ForceAssociate: true || false
};
chimesdkvoice.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 Voice Connector ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

    • ForceAssociate — (Boolean)

      If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

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:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
          • "Gone"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

Examples:

Calling the associatePhoneNumbersWithVoiceConnectorGroup operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorGroupId: 'STRING_VALUE', /* required */
  ForceAssociate: true || false
};
chimesdkvoice.associatePhoneNumbersWithVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Amazon Chime SDK Voice Connector group ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

    • ForceAssociate — (Boolean)

      If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

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:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
          • "Gone"
        • ErrorMessage — (String)

          The error message.

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 SDK 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 */
  ]
};
chimesdkvoice.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:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
          • "Gone"
        • 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 one or more phone numbers.

Service Reference:

Examples:

Calling the batchUpdatePhoneNumber operation

var params = {
  UpdatePhoneNumberRequestItems: [ /* required */
    {
      PhoneNumberId: 'STRING_VALUE', /* required */
      CallingName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      ProductType: VoiceConnector | SipMediaApplicationDialIn
    },
    /* more items */
  ]
};
chimesdkvoice.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>)

      Lists the phone numbers in the update request.

      • PhoneNumberIdrequired — (String)

        The phone number ID to update.

      • ProductType — (String)

        The product type to update.

        Possible values include:
        • "VoiceConnector"
        • "SipMediaApplicationDialIn"
      • CallingName — (String)

        The outbound calling name to update.

      • Name — (String)

        The name of 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:

      • PhoneNumberErrors — (Array<map>)

        A list of failed phone numbers and their error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
          • "Gone"
        • ErrorMessage — (String)

          The error message.

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. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

Service Reference:

Examples:

Calling the createPhoneNumberOrder operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ProductType: VoiceConnector | SipMediaApplicationDialIn, /* required */
  Name: 'STRING_VALUE'
};
chimesdkvoice.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:
      • "VoiceConnector"
      • "SipMediaApplicationDialIn"
    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

    • Name — (String)

      Specifies the name assigned to one or more phone numbers.

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 ID of the phone order.

        • ProductType — (String)

          The phone number order product type.

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

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
          • "PendingDocuments"
          • "Submitted"
          • "FOC"
          • "ChangeRequested"
          • "Exception"
          • "CancelRequested"
          • "Cancelled"
        • OrderType — (String)

          The type of phone number being ordered, local or toll-free.

          Possible values include:
          • "New"
          • "Porting"
        • 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 time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order time stamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

Service Reference:

Examples:

Calling the createProxySession operation

var params = {
  Capabilities: [ /* required */
    Voice | SMS,
    /* more items */
  ],
  ParticipantPhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ExpiryMinutes: 'NUMBER_VALUE',
  GeoMatchLevel: Country | AreaCode,
  GeoMatchParams: {
    AreaCode: 'STRING_VALUE', /* required */
    Country: 'STRING_VALUE' /* required */
  },
  Name: 'STRING_VALUE',
  NumberSelectionBehavior: PreferSticky | AvoidSticky
};
chimesdkvoice.createProxySession(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 Voice Connector ID.

    • ParticipantPhoneNumbers — (Array<String>)

      The participant phone numbers.

    • Name — (String)

      The name of the proxy session.

    • ExpiryMinutes — (Integer)

      The number of minutes allowed for the proxy session.

    • Capabilities — (Array<String>)

      The proxy session's capabilities.

    • NumberSelectionBehavior — (String)

      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

      Possible values include:
      • "PreferSticky"
      • "AvoidSticky"
    • GeoMatchLevel — (String)

      The preference for matching the country or area code of the proxy phone number with that of the first participant.

      Possible values include:
      • "Country"
      • "AreaCode"
    • GeoMatchParams — (map)

      The country and area code for the proxy phone number.

      • Countryrequired — (String)

        The country.

      • AreaCoderequired — (String)

        The area code.

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:

      • ProxySession — (map)

        The proxy session details.

        • VoiceConnectorId — (String)

          The Voice Connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The proxy session name.

        • Status — (String)

          The proxy session status.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

Returns:

  • (AWS.Request)

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

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

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Service Reference:

Examples:

Calling the createSipMediaApplication operation

var params = {
  AwsRegion: 'STRING_VALUE', /* required */
  Endpoints: [ /* required */
    {
      LambdaArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createSipMediaApplication(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: {})
    • AwsRegion — (String)

      The AWS Region assigned to the SIP media application.

    • Name — (String)

      The SIP media application's name.

    • Endpoints — (Array<map>)

      List of endpoints (Lambda ARNs) specified for the SIP media application.

      • LambdaArn — (String)

        Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

    • Tags — (Array<map>)

      The tags assigned to the SIP media application.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

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:

      • SipMediaApplication — (map)

        The SIP media application details.

        • SipMediaApplicationId — (String)

          A SIP media application's ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The SIP media application's name.

        • Endpoints — (Array<map>)

          List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP media application was updated.

        • SipMediaApplicationArn — (String)

          The ARN of the SIP media application.

Returns:

  • (AWS.Request)

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

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

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Service Reference:

Examples:

Calling the createSipMediaApplicationCall operation

var params = {
  FromPhoneNumber: 'STRING_VALUE', /* required */
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  ToPhoneNumber: 'STRING_VALUE', /* required */
  ArgumentsMap: {
    '<SensitiveString>': 'STRING_VALUE',
    /* '<SensitiveString>': ... */
  },
  SipHeaders: {
    '<SensitiveString>': 'STRING_VALUE',
    /* '<SensitiveString>': ... */
  }
};
chimesdkvoice.createSipMediaApplicationCall(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: {})
    • FromPhoneNumber — (String)

      The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

    • ToPhoneNumber — (String)

      The phone number that the service should call.

    • SipMediaApplicationId — (String)

      The ID of the SIP media application.

    • SipHeaders — (map<String>)

      The SIP headers added to an outbound call leg.

    • ArgumentsMap — (map<String>)

      Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"

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:

      • SipMediaApplicationCall — (map)

        The actual call.

        • TransactionId — (String)

          The call's transaction ID.

Returns:

  • (AWS.Request)

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

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

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Service Reference:

Examples:

Calling the createSipRule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  TriggerType: ToPhoneNumber | RequestUriHostname, /* required */
  TriggerValue: 'STRING_VALUE', /* required */
  Disabled: true || false,
  TargetApplications: [
    {
      AwsRegion: 'STRING_VALUE',
      Priority: 'NUMBER_VALUE',
      SipMediaApplicationId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chimesdkvoice.createSipRule(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 SIP rule.

    • TriggerType — (String)

      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

      Possible values include:
      • "ToPhoneNumber"
      • "RequestUriHostname"
    • TriggerValue — (String)

      If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

    • Disabled — (Boolean)

      Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

    • TargetApplications — (Array<map>)

      List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

      • SipMediaApplicationId — (String)

        The ID of a rule's target SIP media application.

      • Priority — (Integer)

        The priority setting of a rule's target SIP media application.

      • AwsRegion — (String)

        The AWS Region of a rule's target SIP media application.

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:

      • SipRule — (map)

        The SIP rule information, including the rule ID, triggers, and target applications.

        • SipRuleId — (String)

          A SIP rule's ID.

        • Name — (String)

          A SIP rule's name.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger set for a SIP rule, either a phone number or a URI request host name.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

        • TargetApplications — (Array<map>)

          The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The ID of a rule's target SIP media application.

          • Priority — (Integer)

            The priority setting of a rule's target SIP media application.

          • AwsRegion — (String)

            The AWS Region of a rule's target SIP media application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was updated, 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 SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

Service Reference:

Examples:

Calling the createVoiceConnector operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RequireEncryption: true || false, /* required */
  AwsRegion: us-east-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1 | eu-west-2 | ap-northeast-2 | ap-northeast-1 | ap-southeast-1 | ap-southeast-2,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.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 Voice Connector.

    • AwsRegion — (String)

      The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

      Possible values include:
      • "us-east-1"
      • "us-west-2"
      • "ca-central-1"
      • "eu-central-1"
      • "eu-west-1"
      • "eu-west-2"
      • "ap-northeast-2"
      • "ap-northeast-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
    • RequireEncryption — (Boolean)

      Enables or disables encryption for the Voice Connector.

    • Tags — (Array<map>)

      The tags assigned to the Voice Connector.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

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 details of the Voice Connector.

        • VoiceConnectorId — (String)

          The Voice Connector's ID.

        • AwsRegion — (String)

          The AWS Region in which the Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
          • "ca-central-1"
          • "eu-central-1"
          • "eu-west-1"
          • "eu-west-2"
          • "ap-northeast-2"
          • "ap-northeast-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
        • Name — (String)

          The Voice Connector's name.

        • OutboundHostName — (String)

          The outbound host name for the Voice Connector.

        • RequireEncryption — (Boolean)

          Enables or disables encryption for the Voice Connector.

        • CreatedTimestamp — (Date)

          The Voice Connector's creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector's updated timestamp, in ISO 8601 format.

        • VoiceConnectorArn — (String)

          The ARN of the Voice Connector.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Service Reference:

Examples:

Calling the createVoiceConnectorGroup operation

var params = {
  Name: 'STRING_VALUE', /* required */
  VoiceConnectorItems: [
    {
      Priority: 'NUMBER_VALUE', /* required */
      VoiceConnectorId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createVoiceConnectorGroup(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 Voice Connector group.

    • VoiceConnectorItems — (Array<map>)

      Lists the Voice Connectors that inbound calls are routed to.

      • VoiceConnectorIdrequired — (String)

        The Voice Connector ID.

      • Priorityrequired — (Integer)

        The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

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:

      • VoiceConnectorGroup — (map)

        The details of the Voice Connector group.

        • VoiceConnectorGroupId — (String)

          The ID of a Voice Connector group.

        • Name — (String)

          The name of a Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Voice Connectors to which you route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

        • CreatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • VoiceConnectorGroupArn — (String)

          The ARN of the Voice Connector group.

Returns:

  • (AWS.Request)

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

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

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Service Reference:

Examples:

Calling the createVoiceProfile operation

var params = {
  SpeakerSearchTaskId: 'STRING_VALUE' /* required */
};
chimesdkvoice.createVoiceProfile(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: {})
    • SpeakerSearchTaskId — (String)

      The ID of the speaker search task.

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:

      • VoiceProfile — (map)

        The requested voice profile.

        • VoiceProfileId — (String)

          The ID of the voice profile.

        • VoiceProfileArn — (String)

          The ARN of the voice profile.

        • VoiceProfileDomainId — (String)

          The ID of the domain that contains the voice profile.

        • CreatedTimestamp — (Date)

          The time at which the voice profile was created and enrolled.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile was last updated.

        • ExpirationTimestamp — (Date)

          The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

Returns:

  • (AWS.Request)

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

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

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Service Reference:

Examples:

Calling the createVoiceProfileDomain operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ServerSideEncryptionConfiguration: { /* required */
    KmsKeyArn: 'STRING_VALUE' /* required */
  },
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createVoiceProfileDomain(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 voice profile domain.

    • Description — (String)

      A description of the voice profile domain.

    • ServerSideEncryptionConfiguration — (map)

      The server-side encryption configuration for the request.

      • KmsKeyArnrequired — (String)

        The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

    • ClientRequestToken — (String)

      The unique identifier for the client request. Use a different token for different domain creation requests.

    • Tags — (Array<map>)

      The tags assigned to the domain.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

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:

      • VoiceProfileDomain — (map)

        The requested voice profile domain.

        • VoiceProfileDomainId — (String)

          The ID of the voice profile domain.

        • VoiceProfileDomainArn — (String)

          The voice profile domain's Amazon Resource Number (ARN).

        • Name — (String)

          The name of the voice profile domain.

        • Description — (String)

          The description of the voice profile domain.

        • ServerSideEncryptionConfiguration — (map)

          A structure that contains the configuration settings for server-side encryption.

          • KmsKeyArnrequired — (String)

            The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

        • CreatedTimestamp — (Date)

          The time at which the voice profile domain was created.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile was last updated.

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 SDK Voice Connectors before it can be deleted.

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

Service Reference:

Examples:

Calling the deletePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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.

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

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the deleteProxySession operation

var params = {
  ProxySessionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteProxySession(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 Voice Connector ID.

    • ProxySessionId — (String)

      The proxy session 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.

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

Deletes a SIP media application.

Service Reference:

Examples:

Calling the deleteSipMediaApplication operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteSipMediaApplication(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application 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.

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

Deletes a SIP rule.

Service Reference:

Examples:

Calling the deleteSipRule operation

var params = {
  SipRuleId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteSipRule(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: {})
    • SipRuleId — (String)

      The SIP rule 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 an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

Service Reference:

Examples:

Calling the deleteVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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.

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

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

Examples:

Calling the deleteVoiceConnectorEmergencyCallingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteVoiceConnectorEmergencyCallingConfiguration(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 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.

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

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

Service Reference:

Examples:

Calling the deleteVoiceConnectorGroup operation

var params = {
  VoiceConnectorGroupId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Voice Connector Group 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 SDK Voice Connector.

Note: If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

Service Reference:

Examples:

Calling the deleteVoiceConnectorOrigination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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.

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

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the deleteVoiceConnectorProxy operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteVoiceConnectorProxy(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 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.

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

Deletes a Voice Connector's streaming configuration.

Examples:

Calling the deleteVoiceConnectorStreamingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteVoiceConnectorStreamingConfiguration(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 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 SDK Voice Connector.

Note: If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

Service Reference:

Examples:

Calling the deleteVoiceConnectorTermination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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 = {
  Usernames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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.

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

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

Service Reference:

Examples:

Calling the deleteVoiceProfile operation

var params = {
  VoiceProfileId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteVoiceProfile(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: {})
    • VoiceProfileId — (String)

      The voice profile 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.

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

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

Service Reference:

Examples:

Calling the deleteVoiceProfileDomain operation

var params = {
  VoiceProfileDomainId: 'STRING_VALUE' /* required */
};
chimesdkvoice.deleteVoiceProfileDomain(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: {})
    • VoiceProfileDomainId — (String)

      The voice profile domain 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 numbers from the specified Amazon Chime SDK Voice Connector.

Examples:

Calling the disassociatePhoneNumbersFromVoiceConnector operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
          • "Gone"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

Examples:

Calling the disassociatePhoneNumbersFromVoiceConnectorGroup operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorGroupId: 'STRING_VALUE' /* required */
};
chimesdkvoice.disassociatePhoneNumbersFromVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Voice Connector group ID.

    • E164PhoneNumbers — (Array<String>)

      The 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:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
          • "Gone"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Service Reference:

Examples:

Calling the getGlobalSettings operation

chimesdkvoice.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:

      • VoiceConnector — (map)

        The Voice Connector settings.

        • CdrBucket — (String)

          The S3 bucket that stores the Voice Connector's call detail records.

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 */
};
chimesdkvoice.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's ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Country — (String)

          The phone number's country. Format: ISO 3166-1 alpha-2.

        • Type — (String)

          The phone number's type.

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

          The phone number's product type.

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

          The phone number's status.

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

          The phone number's 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 inbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number's associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

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

            Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

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

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • 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.

        • OrderId — (String)

          The phone number's order ID.

        • Name — (String)

          The name of the phone number.

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 the 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 */
};
chimesdkvoice.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 of 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 ID of the phone order.

        • ProductType — (String)

          The phone number order product type.

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

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
          • "PendingDocuments"
          • "Submitted"
          • "FOC"
          • "ChangeRequested"
          • "Exception"
          • "CancelRequested"
          • "Cancelled"
        • OrderType — (String)

          The type of phone number being ordered, local or toll-free.

          Possible values include:
          • "New"
          • "Porting"
        • 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 time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order time stamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Service Reference:

Examples:

Calling the getPhoneNumberSettings operation

chimesdkvoice.getPhoneNumberSettings(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:

      • CallingName — (String)

        The default outbound calling name for the account.

      • CallingNameUpdatedTimestamp — (Date)

        The updated outbound calling name timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the getProxySession operation

var params = {
  ProxySessionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getProxySession(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 Voice Connector ID.

    • ProxySessionId — (String)

      The proxy session 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:

      • ProxySession — (map)

        The proxy session details.

        • VoiceConnectorId — (String)

          The Voice Connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The proxy session name.

        • Status — (String)

          The proxy session status.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

Returns:

  • (AWS.Request)

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

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

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Service Reference:

Examples:

Calling the getSipMediaApplication operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getSipMediaApplication(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application 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:

      • SipMediaApplication — (map)

        The details of the SIP media application.

        • SipMediaApplicationId — (String)

          A SIP media application's ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The SIP media application's name.

        • Endpoints — (Array<map>)

          List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP media application was updated.

        • SipMediaApplicationArn — (String)

          The ARN of the SIP media application.

Returns:

  • (AWS.Request)

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

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

Gets the Alexa Skill configuration for the SIP media application.

Examples:

Calling the getSipMediaApplicationAlexaSkillConfiguration operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getSipMediaApplicationAlexaSkillConfiguration(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application 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:

      • SipMediaApplicationAlexaSkillConfiguration — (map)

        Returns the Alexa Skill configuration.

        • AlexaSkillStatusrequired — (String)

          The status of the Alexa Skill configuration.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • AlexaSkillIdsrequired — (Array<String>)

          The ID of the Alexa Skill configuration.

Returns:

  • (AWS.Request)

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

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

Retrieves the logging configuration for the specified SIP media application.

Examples:

Calling the getSipMediaApplicationLoggingConfiguration operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getSipMediaApplicationLoggingConfiguration(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application 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:

      • SipMediaApplicationLoggingConfiguration — (map)

        The actual logging configuration.

        • EnableSipMediaApplicationMessageLogs — (Boolean)

          Enables message logging for the specified SIP media application.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Service Reference:

Examples:

Calling the getSipRule operation

var params = {
  SipRuleId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getSipRule(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: {})
    • SipRuleId — (String)

      The SIP rule 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:

      • SipRule — (map)

        The SIP rule details.

        • SipRuleId — (String)

          A SIP rule's ID.

        • Name — (String)

          A SIP rule's name.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger set for a SIP rule, either a phone number or a URI request host name.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

        • TargetApplications — (Array<map>)

          The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The ID of a rule's target SIP media application.

          • Priority — (Integer)

            The priority setting of a rule's target SIP media application.

          • AwsRegion — (String)

            The AWS Region of a rule's target SIP media application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of the specified speaker search task.

Service Reference:

Examples:

Calling the getSpeakerSearchTask operation

var params = {
  SpeakerSearchTaskId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getSpeakerSearchTask(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 Voice Connector ID.

    • SpeakerSearchTaskId — (String)

      The ID of the speaker search task.

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:

      • SpeakerSearchTask — (map)

        The details of the speaker search task.

        • SpeakerSearchTaskId — (String)

          The speaker search task ID.

        • SpeakerSearchTaskStatus — (String)

          The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

        • CallDetails — (map)

          The call details of a speaker search task.

          • VoiceConnectorId — (String)

            The Voice Connector ID.

          • TransactionId — (String)

            The transaction ID of a Voice Connector call.

          • IsCaller — (Boolean)

            Identifies a person as the caller or the callee.

        • SpeakerSearchDetails — (map)

          The details of a speaker search task.

          • Results — (Array<map>)

            The result value in the speaker search details.

            • ConfidenceScore — (Float)

              The confidence score in the speaker search analysis.

            • VoiceProfileId — (String)

              The voice profile ID.

          • VoiceprintGenerationStatus — (String)

            The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..

        • CreatedTimestamp — (Date)

          The time at which a speaker search task was created.

        • UpdatedTimestamp — (Date)

          The time at which a speaker search task was updated.

        • StartedTimestamp — (Date)

          The time at which the speaker search task began.

        • StatusMessage — (String)

          A detailed message about the status of a speaker search.

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 SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

Service Reference:

Examples:

Calling the getVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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 Voice Connector details.

        • VoiceConnectorId — (String)

          The Voice Connector's ID.

        • AwsRegion — (String)

          The AWS Region in which the Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
          • "ca-central-1"
          • "eu-central-1"
          • "eu-west-1"
          • "eu-west-2"
          • "ap-northeast-2"
          • "ap-northeast-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
        • Name — (String)

          The Voice Connector's name.

        • OutboundHostName — (String)

          The outbound host name for the Voice Connector.

        • RequireEncryption — (Boolean)

          Enables or disables encryption for the Voice Connector.

        • CreatedTimestamp — (Date)

          The Voice Connector's creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector's updated timestamp, in ISO 8601 format.

        • VoiceConnectorArn — (String)

          The ARN of the Voice Connector.

Returns:

  • (AWS.Request)

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

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

Retrieves the emergency calling configuration details for the specified Voice Connector.

Examples:

Calling the getVoiceConnectorEmergencyCallingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceConnectorEmergencyCallingConfiguration(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 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:

      • EmergencyCallingConfiguration — (map)

        The details of the emergency calling configuration.

        • DNIS — (Array<map>)

          The Dialed Number Identification Service (DNIS) emergency calling configuration details.

          • EmergencyPhoneNumberrequired — (String)

            The DNIS phone number that you route emergency calls to, in E.164 format.

          • TestPhoneNumber — (String)

            The DNIS phone number for routing test emergency calls to, in E.164 format.

          • CallingCountryrequired — (String)

            The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

Service Reference:

Examples:

Calling the getVoiceConnectorGroup operation

var params = {
  VoiceConnectorGroupId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Voice Connector group 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:

      • VoiceConnectorGroup — (map)

        The details of the Voice Connector group.

        • VoiceConnectorGroupId — (String)

          The ID of a Voice Connector group.

        • Name — (String)

          The name of a Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Voice Connectors to which you route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

        • CreatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • VoiceConnectorGroupArn — (String)

          The ARN of the Voice Connector group.

Returns:

  • (AWS.Request)

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

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

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Examples:

Calling the getVoiceConnectorLoggingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceConnectorLoggingConfiguration(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 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:

      • LoggingConfiguration — (map)

        The logging configuration details .

        • EnableSIPLogs — (Boolean)

          Boolean that enables sending SIP message logs to Amazon CloudWatch.

        • EnableMediaMetricLogs — (Boolean)

          Enables or disables media metrics logging.

Returns:

  • (AWS.Request)

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

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

Retrieves the origination settings for the specified Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorOrigination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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. This parameter is not required, but you must specify this parameter or Disabled.

          • Host — (String)

            The FQDN 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 SDK 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 assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

        • Disabled — (Boolean)

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

Returns:

  • (AWS.Request)

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

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

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorProxy operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceConnectorProxy(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 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:

      • Proxy — (map)

        The proxy configuration details.

        • DefaultSessionExpiryMinutes — (Integer)

          The default number of minutes allowed for proxy sessions.

        • Disabled — (Boolean)

          When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

        • FallBackPhoneNumber — (String)

          The phone number to route calls to after a proxy session expires.

        • PhoneNumberCountries — (Array<String>)

          The countries for proxy phone numbers to be selected from.

Returns:

  • (AWS.Request)

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

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

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Examples:

Calling the getVoiceConnectorStreamingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceConnectorStreamingConfiguration(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 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:

      • StreamingConfiguration — (map)

        The details of the streaming configuration.

        • DataRetentionInHoursrequired — (Integer)

          The amount of time, in hours, to the Kinesis data.

        • Disabledrequired — (Boolean)

          When true, streaming to Kinesis is off.

        • StreamingNotificationTargets — (Array<map>)

          The streaming notification targets.

          • NotificationTarget — (String)

            The streaming notification target.

            Possible values include:
            • "EventBridge"
            • "SNS"
            • "SQS"
        • MediaInsightsConfiguration — (map)

          The call analytics configuration.

          • Disabled — (Boolean)

            Denotes the configration as enabled or disabled.

          • ConfigurationArn — (String)

            The configuration's ARN.

Returns:

  • (AWS.Request)

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

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

Retrieves the termination setting details for the specified Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorTermination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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 quota. Default value of 1.

        • DefaultPhoneNumber — (String)

          The default outbound calling number.

        • CallingRegions — (Array<String>)

          The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • CidrAllowedList — (Array<String>)

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

        • Disabled — (Boolean)

          When termination is disabled, outbound calls cannot 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 SDK Voice Connector.

Examples:

Calling the getVoiceConnectorTerminationHealth operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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.

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

Retrieves the details of the specified voice profile.

Service Reference:

Examples:

Calling the getVoiceProfile operation

var params = {
  VoiceProfileId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceProfile(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: {})
    • VoiceProfileId — (String)

      The voice profile 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:

      • VoiceProfile — (map)

        The voice profile details.

        • VoiceProfileId — (String)

          The ID of the voice profile.

        • VoiceProfileArn — (String)

          The ARN of the voice profile.

        • VoiceProfileDomainId — (String)

          The ID of the domain that contains the voice profile.

        • CreatedTimestamp — (Date)

          The time at which the voice profile was created and enrolled.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile was last updated.

        • ExpirationTimestamp — (Date)

          The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of the specified voice profile domain.

Service Reference:

Examples:

Calling the getVoiceProfileDomain operation

var params = {
  VoiceProfileDomainId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceProfileDomain(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: {})
    • VoiceProfileDomainId — (String)

      The voice profile domain 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:

      • VoiceProfileDomain — (map)

        The details of the voice profile domain.

        • VoiceProfileDomainId — (String)

          The ID of the voice profile domain.

        • VoiceProfileDomainArn — (String)

          The voice profile domain's Amazon Resource Number (ARN).

        • Name — (String)

          The name of the voice profile domain.

        • Description — (String)

          The description of the voice profile domain.

        • ServerSideEncryptionConfiguration — (map)

          A structure that contains the configuration settings for server-side encryption.

          • KmsKeyArnrequired — (String)

            The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

        • CreatedTimestamp — (Date)

          The time at which the voice profile domain was created.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile was last updated.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of a voice tone analysis task.

Service Reference:

Examples:

Calling the getVoiceToneAnalysisTask operation

var params = {
  IsCaller: true || false, /* required */
  VoiceConnectorId: 'STRING_VALUE', /* required */
  VoiceToneAnalysisTaskId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceToneAnalysisTask(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 Voice Connector ID.

    • VoiceToneAnalysisTaskId — (String)

      The ID of the voice tone anlysis task.

    • IsCaller — (Boolean)

      Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

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:

      • VoiceToneAnalysisTask — (map)

        The details of the voice tone analysis task.

        • VoiceToneAnalysisTaskId — (String)

          The ID of the voice tone analysis task.

        • VoiceToneAnalysisTaskStatus — (String)

          The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

        • CallDetails — (map)

          The call details of a voice tone analysis task.

          • VoiceConnectorId — (String)

            The Voice Connector ID.

          • TransactionId — (String)

            The transaction ID of a Voice Connector call.

          • IsCaller — (Boolean)

            Identifies a person as the caller or the callee.

        • CreatedTimestamp — (Date)

          The time at which a voice tone analysis task was created.

        • UpdatedTimestamp — (Date)

          The time at which a voice tone analysis task was updated.

        • StartedTimestamp — (Date)

          The time at which a voice tone analysis task started.

        • StatusMessage — (String)

          The status of a voice tone analysis task.

Returns:

  • (AWS.Request)

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

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

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

Examples:

Calling the listAvailableVoiceConnectorRegions operation

chimesdkvoice.listAvailableVoiceConnectorRegions(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:

      • VoiceConnectorRegions — (Array<String>)

        The list of AWS Regions.

Returns:

  • (AWS.Request)

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

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

Lists the phone numbers for an administrator's Amazon Chime SDK account.

Service Reference:

Examples:

Calling the listPhoneNumberOrders operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkvoice.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 used 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 ID of the phone order.

        • ProductType — (String)

          The phone number order product type.

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

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
          • "PendingDocuments"
          • "Submitted"
          • "FOC"
          • "ChangeRequested"
          • "Exception"
          • "CancelRequested"
          • "Cancelled"
        • OrderType — (String)

          The type of phone number being ordered, local or toll-free.

          Possible values include:
          • "New"
          • "Porting"
        • 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 time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order time stamp, in ISO 8601 format.

      • NextToken — (String)

        The token used 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 SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

Service Reference:

Examples:

Calling the listPhoneNumbers operation

var params = {
  FilterName: VoiceConnectorId | VoiceConnectorGroupId | SipRuleId,
  FilterValue: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProductType: VoiceConnector | SipMediaApplicationDialIn,
  Status: 'STRING_VALUE'
};
chimesdkvoice.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 status of your organization's phone numbers.

    • ProductType — (String)

      The phone number product types.

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

      The filter to limit the number of results.

      Possible values include:
      • "VoiceConnectorId"
      • "VoiceConnectorGroupId"
      • "SipRuleId"
    • FilterValue — (String)

      The filter value.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token used to return 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's ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Country — (String)

          The phone number's country. Format: ISO 3166-1 alpha-2.

        • Type — (String)

          The phone number's type.

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

          The phone number's product type.

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

          The phone number's status.

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

          The phone number's 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 inbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number's associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

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

            Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

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

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • 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.

        • OrderId — (String)

          The phone number's order ID.

        • Name — (String)

          The name of the phone number.

      • NextToken — (String)

        The token used to return the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the listProxySessions operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: Open | InProgress | Closed
};
chimesdkvoice.listProxySessions(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 Voice Connector ID.

    • Status — (String)

      The proxy session status.

      Possible values include:
      • "Open"
      • "InProgress"
      • "Closed"
    • NextToken — (String)

      The token used 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:

      • ProxySessions — (Array<map>)

        The proxy sessions' details.

        • VoiceConnectorId — (String)

          The Voice Connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The proxy session name.

        • Status — (String)

          The proxy session status.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

      • NextToken — (String)

        The token used to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the SIP media applications under the administrator's AWS account.

Service Reference:

Examples:

Calling the listSipMediaApplications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkvoice.listSipMediaApplications(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: {})
    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token used to return 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:

      • SipMediaApplications — (Array<map>)

        The list of SIP media applications and application details.

        • SipMediaApplicationId — (String)

          A SIP media application's ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The SIP media application's name.

        • Endpoints — (Array<map>)

          List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP media application was updated.

        • SipMediaApplicationArn — (String)

          The ARN of the SIP media application.

      • NextToken — (String)

        The token used to return the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the SIP rules under the administrator's AWS account.

Service Reference:

Examples:

Calling the listSipRules operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SipMediaApplicationId: 'STRING_VALUE'
};
chimesdkvoice.listSipRules(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token used to return 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:

      • SipRules — (Array<map>)

        The list of SIP rules and details.

        • SipRuleId — (String)

          A SIP rule's ID.

        • Name — (String)

          A SIP rule's name.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger set for a SIP rule, either a phone number or a URI request host name.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

        • TargetApplications — (Array<map>)

          The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The ID of a rule's target SIP media application.

          • Priority — (Integer)

            The priority setting of a rule's target SIP media application.

          • AwsRegion — (String)

            The AWS Region of a rule's target SIP media application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was updated, in ISO 8601 format.

      • NextToken — (String)

        The token used to return the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the countries that you can order phone numbers from.

Examples:

Calling the listSupportedPhoneNumberCountries operation

var params = {
  ProductType: VoiceConnector | SipMediaApplicationDialIn /* required */
};
chimesdkvoice.listSupportedPhoneNumberCountries(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:
      • "VoiceConnector"
      • "SipMediaApplicationDialIn"

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:

      • PhoneNumberCountries — (Array<map>)

        The supported phone number countries.

        • CountryCode — (String)

          The phone number country code. Format: ISO 3166-1 alpha-2.

        • SupportedPhoneNumberTypes — (Array<String>)

          The supported phone number types.

Returns:

  • (AWS.Request)

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

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

Returns a list of the tags in a given resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
chimesdkvoice.listTagsForResource(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: {})
    • ResourceARN — (String)

      The resource ARN.

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:

      • Tags — (Array<map>)

        The tags in the list.

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

Returns:

  • (AWS.Request)

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

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

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

Service Reference:

Examples:

Calling the listVoiceConnectorGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkvoice.listVoiceConnectorGroups(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 used to return 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:

      • VoiceConnectorGroups — (Array<map>)

        The details of the Voice Connector groups.

        • VoiceConnectorGroupId — (String)

          The ID of a Voice Connector group.

        • Name — (String)

          The name of a Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Voice Connectors to which you route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

        • CreatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • VoiceConnectorGroupArn — (String)

          The ARN of the Voice Connector group.

      • NextToken — (String)

        The token used to return 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 SDK Voice Connectors in the administrators AWS account.

Service Reference:

Examples:

Calling the listVoiceConnectors operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkvoice.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 used to return 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 Voice Connectors.

        • VoiceConnectorId — (String)

          The Voice Connector's ID.

        • AwsRegion — (String)

          The AWS Region in which the Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
          • "ca-central-1"
          • "eu-central-1"
          • "eu-west-1"
          • "eu-west-2"
          • "ap-northeast-2"
          • "ap-northeast-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
        • Name — (String)

          The Voice Connector's name.

        • OutboundHostName — (String)

          The outbound host name for the Voice Connector.

        • RequireEncryption — (Boolean)

          Enables or disables encryption for the Voice Connector.

        • CreatedTimestamp — (Date)

          The Voice Connector's creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector's updated timestamp, in ISO 8601 format.

        • VoiceConnectorArn — (String)

          The ARN of the Voice Connector.

      • NextToken — (String)

        The token used to return 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 SDK Voice Connector.

Examples:

Calling the listVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 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.

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

Lists the specified voice profile domains in the administrator's AWS account.

Service Reference:

Examples:

Calling the listVoiceProfileDomains operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkvoice.listVoiceProfileDomains(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 used to return 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:

      • VoiceProfileDomains — (Array<map>)

        The list of voice profile domains.

        • VoiceProfileDomainId — (String)

          The ID of the voice profile domain summary.

        • VoiceProfileDomainArn — (String)

          The ARN of a voice profile in a voice profile domain summary.

        • Name — (String)

          The name of the voice profile domain summary.

        • Description — (String)

          Describes the voice profile domain summary.

        • CreatedTimestamp — (Date)

          The time at which the voice profile domain summary was created.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile domain summary was last updated.

      • NextToken — (String)

        The token used to return the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the voice profiles in a voice profile domain.

Service Reference:

Examples:

Calling the listVoiceProfiles operation

var params = {
  VoiceProfileDomainId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkvoice.listVoiceProfiles(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: {})
    • VoiceProfileDomainId — (String)

      The ID of the voice profile domain.

    • NextToken — (String)

      The token used to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results in the request.

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:

      • VoiceProfiles — (Array<map>)

        The list of voice profiles.

        • VoiceProfileId — (String)

          The ID of the voice profile in a voice profile summary.

        • VoiceProfileArn — (String)

          The ARN of the voice profile in a voice profile summary.

        • VoiceProfileDomainId — (String)

          The ID of the voice profile domain in a voice profile summary.

        • CreatedTimestamp — (Date)

          The time at which a voice profile summary was created.

        • UpdatedTimestamp — (Date)

          The time at which a voice profile summary was last updated.

        • ExpirationTimestamp — (Date)

          Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile's voice print and extend the life of the summary.

      • NextToken — (String)

        The token used to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Updates the Alexa Skill configuration for the SIP media application.

Examples:

Calling the putSipMediaApplicationAlexaSkillConfiguration operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  SipMediaApplicationAlexaSkillConfiguration: {
    AlexaSkillIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    AlexaSkillStatus: ACTIVE | INACTIVE /* required */
  }
};
chimesdkvoice.putSipMediaApplicationAlexaSkillConfiguration(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

    • SipMediaApplicationAlexaSkillConfiguration — (map)

      The Alexa Skill configuration.

      • AlexaSkillStatusrequired — (String)

        The status of the Alexa Skill configuration.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • AlexaSkillIdsrequired — (Array<String>)

        The ID of the Alexa Skill configuration.

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:

      • SipMediaApplicationAlexaSkillConfiguration — (map)

        Returns the Alexa Skill configuration.

        • AlexaSkillStatusrequired — (String)

          The status of the Alexa Skill configuration.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • AlexaSkillIdsrequired — (Array<String>)

          The ID of the Alexa Skill configuration.

Returns:

  • (AWS.Request)

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

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

Updates the logging configuration for the specified SIP media application.

Examples:

Calling the putSipMediaApplicationLoggingConfiguration operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  SipMediaApplicationLoggingConfiguration: {
    EnableSipMediaApplicationMessageLogs: true || false
  }
};
chimesdkvoice.putSipMediaApplicationLoggingConfiguration(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

    • SipMediaApplicationLoggingConfiguration — (map)

      The logging configuration for the specified SIP media application.

      • EnableSipMediaApplicationMessageLogs — (Boolean)

        Enables message logging for the specified SIP media application.

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:

      • SipMediaApplicationLoggingConfiguration — (map)

        The updated logging configuration for the specified SIP media application.

        • EnableSipMediaApplicationMessageLogs — (Boolean)

          Enables message logging for the specified SIP media application.

Returns:

  • (AWS.Request)

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

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

Updates a Voice Connector's emergency calling configuration.

Examples:

Calling the putVoiceConnectorEmergencyCallingConfiguration operation

var params = {
  EmergencyCallingConfiguration: { /* required */
    DNIS: [
      {
        CallingCountry: 'STRING_VALUE', /* required */
        EmergencyPhoneNumber: 'STRING_VALUE', /* required */
        TestPhoneNumber: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.putVoiceConnectorEmergencyCallingConfiguration(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 Voice Connector ID.

    • EmergencyCallingConfiguration — (map)

      The configuration being updated.

      • DNIS — (Array<map>)

        The Dialed Number Identification Service (DNIS) emergency calling configuration details.

        • EmergencyPhoneNumberrequired — (String)

          The DNIS phone number that you route emergency calls to, in E.164 format.

        • TestPhoneNumber — (String)

          The DNIS phone number for routing test emergency calls to, in E.164 format.

        • CallingCountryrequired — (String)

          The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 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:

      • EmergencyCallingConfiguration — (map)

        The updated configuration.

        • DNIS — (Array<map>)

          The Dialed Number Identification Service (DNIS) emergency calling configuration details.

          • EmergencyPhoneNumberrequired — (String)

            The DNIS phone number that you route emergency calls to, in E.164 format.

          • TestPhoneNumber — (String)

            The DNIS phone number for routing test emergency calls to, in E.164 format.

          • CallingCountryrequired — (String)

            The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Returns:

  • (AWS.Request)

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

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

Updates a Voice Connector's logging configuration.

Examples:

Calling the putVoiceConnectorLoggingConfiguration operation

var params = {
  LoggingConfiguration: { /* required */
    EnableMediaMetricLogs: true || false,
    EnableSIPLogs: true || false
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.putVoiceConnectorLoggingConfiguration(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 Voice Connector ID.

    • LoggingConfiguration — (map)

      The logging configuration being updated.

      • EnableSIPLogs — (Boolean)

        Boolean that enables sending SIP message logs to Amazon CloudWatch.

      • EnableMediaMetricLogs — (Boolean)

        Enables or disables media metrics logging.

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:

      • LoggingConfiguration — (map)

        The updated logging configuration.

        • EnableSIPLogs — (Boolean)

          Boolean that enables sending SIP message logs to Amazon CloudWatch.

        • EnableMediaMetricLogs — (Boolean)

          Enables or disables media metrics logging.

Returns:

  • (AWS.Request)

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

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

Updates a Voice Connector's origination settings.

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 */
};
chimesdkvoice.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 Voice Connector ID.

    • Origination — (map)

      The origination settings being updated.

      • Routes — (Array<map>)

        The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

        • Host — (String)

          The FQDN 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 SDK 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 assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

      • Disabled — (Boolean)

        When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

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 settings.

        • Routes — (Array<map>)

          The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

          • Host — (String)

            The FQDN 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 SDK 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 assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

        • Disabled — (Boolean)

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

Returns:

  • (AWS.Request)

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

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

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the putVoiceConnectorProxy operation

var params = {
  DefaultSessionExpiryMinutes: 'NUMBER_VALUE', /* required */
  PhoneNumberPoolCountries: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  Disabled: true || false,
  FallBackPhoneNumber: 'STRING_VALUE'
};
chimesdkvoice.putVoiceConnectorProxy(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 Voice Connector ID.

    • DefaultSessionExpiryMinutes — (Integer)

      The default number of minutes allowed for proxy session.

    • PhoneNumberPoolCountries — (Array<String>)

      The countries for proxy phone numbers to be selected from.

    • FallBackPhoneNumber — (String)

      The phone number to route calls to after a proxy session expires.

    • Disabled — (Boolean)

      When true, stops proxy sessions from being created on the specified Amazon Chime SDK 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:

      • Proxy — (map)

        The proxy configuration details.

        • DefaultSessionExpiryMinutes — (Integer)

          The default number of minutes allowed for proxy sessions.

        • Disabled — (Boolean)

          When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

        • FallBackPhoneNumber — (String)

          The phone number to route calls to after a proxy session expires.

        • PhoneNumberCountries — (Array<String>)

          The countries for proxy phone numbers to be selected from.

Returns:

  • (AWS.Request)

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

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

Updates a Voice Connector's streaming configuration settings.

Examples:

Calling the putVoiceConnectorStreamingConfiguration operation

var params = {
  StreamingConfiguration: { /* required */
    DataRetentionInHours: 'NUMBER_VALUE', /* required */
    Disabled: true || false, /* required */
    MediaInsightsConfiguration: {
      ConfigurationArn: 'STRING_VALUE',
      Disabled: true || false
    },
    StreamingNotificationTargets: [
      {
        NotificationTarget: EventBridge | SNS | SQS
      },
      /* more items */
    ]
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.putVoiceConnectorStreamingConfiguration(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 Voice Connector ID.

    • StreamingConfiguration — (map)

      The streaming settings being updated.

      • DataRetentionInHoursrequired — (Integer)

        The amount of time, in hours, to the Kinesis data.

      • Disabledrequired — (Boolean)

        When true, streaming to Kinesis is off.

      • StreamingNotificationTargets — (Array<map>)

        The streaming notification targets.

        • NotificationTarget — (String)

          The streaming notification target.

          Possible values include:
          • "EventBridge"
          • "SNS"
          • "SQS"
      • MediaInsightsConfiguration — (map)

        The call analytics configuration.

        • Disabled — (Boolean)

          Denotes the configration as enabled or disabled.

        • ConfigurationArn — (String)

          The configuration's ARN.

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:

      • StreamingConfiguration — (map)

        The updated streaming settings.

        • DataRetentionInHoursrequired — (Integer)

          The amount of time, in hours, to the Kinesis data.

        • Disabledrequired — (Boolean)

          When true, streaming to Kinesis is off.

        • StreamingNotificationTargets — (Array<map>)

          The streaming notification targets.

          • NotificationTarget — (String)

            The streaming notification target.

            Possible values include:
            • "EventBridge"
            • "SNS"
            • "SQS"
        • MediaInsightsConfiguration — (map)

          The call analytics configuration.

          • Disabled — (Boolean)

            Denotes the configration as enabled or disabled.

          • ConfigurationArn — (String)

            The configuration's ARN.

Returns:

  • (AWS.Request)

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

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

Updates a Voice Connector's termination settings.

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 */
};
chimesdkvoice.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 Voice Connector ID.

    • Termination — (map)

      The termination settings to be updated.

      • CpsLimit — (Integer)

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

      • DefaultPhoneNumber — (String)

        The default outbound calling number.

      • CallingRegions — (Array<String>)

        The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

      • CidrAllowedList — (Array<String>)

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

      • Disabled — (Boolean)

        When termination is disabled, outbound calls cannot 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 settings.

        • CpsLimit — (Integer)

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

        • DefaultPhoneNumber — (String)

          The default outbound calling number.

        • CallingRegions — (Array<String>)

          The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • CidrAllowedList — (Array<String>)

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

        • Disabled — (Boolean)

          When termination is disabled, outbound calls cannot be made.

Returns:

  • (AWS.Request)

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

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

Updates a Voice Connector's termination credentials.

Examples:

Calling the putVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  Credentials: [
    {
      Password: 'STRING_VALUE',
      Username: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chimesdkvoice.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 Voice Connector ID.

    • Credentials — (Array<map>)

      The termination credentials being updated.

      • 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.

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

Restores a deleted phone number.

Service Reference:

Examples:

Calling the restorePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 ID of the phone number being restored.

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 restored phone number.

        • PhoneNumberId — (String)

          The phone number's ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Country — (String)

          The phone number's country. Format: ISO 3166-1 alpha-2.

        • Type — (String)

          The phone number's type.

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

          The phone number's product type.

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

          The phone number's status.

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

          The phone number's 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 inbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number's associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

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

            Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

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

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • 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.

        • OrderId — (String)

          The phone number's order ID.

        • Name — (String)

          The name of the phone number.

Returns:

  • (AWS.Request)

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

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

Searches the provisioned phone numbers in an organization.

Service Reference:

Examples:

Calling the searchAvailablePhoneNumbers operation

var params = {
  AreaCode: 'STRING_VALUE',
  City: 'STRING_VALUE',
  Country: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PhoneNumberType: Local | TollFree,
  State: 'STRING_VALUE',
  TollFreePrefix: 'STRING_VALUE'
};
chimesdkvoice.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)

      Confines a search to just the phone numbers associated with the specified area code.

    • City — (String)

      Confines a search to just the phone numbers associated with the specified city.

    • Country — (String)

      Confines a search to just the phone numbers associated with the specified country.

    • State — (String)

      Confines a search to just the phone numbers associated with the specified state.

    • TollFreePrefix — (String)

      Confines a search to just the phone numbers associated with the specified toll-free prefix.

    • PhoneNumberType — (String)

      Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

      Possible values include:
      • "Local"
      • "TollFree"
    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token used to return 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>)

        Confines a search to just the phone numbers in the E.164 format.

      • NextToken — (String)

        The token used to return the next page of results.

Returns:

  • (AWS.Request)

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

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

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

Service Reference:

Examples:

Calling the startSpeakerSearchTask operation

var params = {
  TransactionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE', /* required */
  VoiceProfileDomainId: 'STRING_VALUE', /* required */
  CallLeg: Caller | Callee,
  ClientRequestToken: 'STRING_VALUE'
};
chimesdkvoice.startSpeakerSearchTask(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 Voice Connector ID.

    • TransactionId — (String)

      The transaction ID of the call being analyzed.

    • VoiceProfileDomainId — (String)

      The ID of the voice profile domain that will store the voice profile.

    • ClientRequestToken — (String)

      The unique identifier for the client request. Use a different token for different speaker search tasks.

    • CallLeg — (String)

      Specifies which call leg to stream for speaker search.

      Possible values include:
      • "Caller"
      • "Callee"

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:

      • SpeakerSearchTask — (map)

        The details of the speaker search task.

        • SpeakerSearchTaskId — (String)

          The speaker search task ID.

        • SpeakerSearchTaskStatus — (String)

          The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

        • CallDetails — (map)

          The call details of a speaker search task.

          • VoiceConnectorId — (String)

            The Voice Connector ID.

          • TransactionId — (String)

            The transaction ID of a Voice Connector call.

          • IsCaller — (Boolean)

            Identifies a person as the caller or the callee.

        • SpeakerSearchDetails — (map)

          The details of a speaker search task.

          • Results — (Array<map>)

            The result value in the speaker search details.

            • ConfidenceScore — (Float)

              The confidence score in the speaker search analysis.

            • VoiceProfileId — (String)

              The voice profile ID.

          • VoiceprintGenerationStatus — (String)

            The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..

        • CreatedTimestamp — (Date)

          The time at which a speaker search task was created.

        • UpdatedTimestamp — (Date)

          The time at which a speaker search task was updated.

        • StartedTimestamp — (Date)

          The time at which the speaker search task began.

        • StatusMessage — (String)

          A detailed message about the status of a speaker search.

Returns:

  • (AWS.Request)

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

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

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

Service Reference:

Examples:

Calling the startVoiceToneAnalysisTask operation

var params = {
  LanguageCode: en-US, /* required */
  TransactionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
chimesdkvoice.startVoiceToneAnalysisTask(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 Voice Connector ID.

    • TransactionId — (String)

      The transaction ID.

    • LanguageCode — (String)

      The language code.

      Possible values include:
      • "en-US"
    • ClientRequestToken — (String)

      The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

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:

      • VoiceToneAnalysisTask — (map)

        The details of the voice tone analysis task.

        • VoiceToneAnalysisTaskId — (String)

          The ID of the voice tone analysis task.

        • VoiceToneAnalysisTaskStatus — (String)

          The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

        • CallDetails — (map)

          The call details of a voice tone analysis task.

          • VoiceConnectorId — (String)

            The Voice Connector ID.

          • TransactionId — (String)

            The transaction ID of a Voice Connector call.

          • IsCaller — (Boolean)

            Identifies a person as the caller or the callee.

        • CreatedTimestamp — (Date)

          The time at which a voice tone analysis task was created.

        • UpdatedTimestamp — (Date)

          The time at which a voice tone analysis task was updated.

        • StartedTimestamp — (Date)

          The time at which a voice tone analysis task started.

        • StatusMessage — (String)

          The status of a voice tone analysis task.

Returns:

  • (AWS.Request)

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

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

Stops a speaker search task.

Service Reference:

Examples:

Calling the stopSpeakerSearchTask operation

var params = {
  SpeakerSearchTaskId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.stopSpeakerSearchTask(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 Voice Connector ID.

    • SpeakerSearchTaskId — (String)

      The speaker search task 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.

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

Stops a voice tone analysis task.

Service Reference:

Examples:

Calling the stopVoiceToneAnalysisTask operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  VoiceToneAnalysisTaskId: 'STRING_VALUE' /* required */
};
chimesdkvoice.stopVoiceToneAnalysisTask(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 Voice Connector ID.

    • VoiceToneAnalysisTaskId — (String)

      The ID of the voice tone analysis task.

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.

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

Adds a tag to the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.tagResource(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: {})
    • ResourceARN — (String)

      The ARN of the resource being tagged.

    • Tags — (Array<map>)

      A list of the tags being added to the resource.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

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.

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

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chimesdkvoice.untagResource(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: {})
    • ResourceARN — (String)

      The ARN of the resource having its tags removed.

    • TagKeys — (Array<String>)

      The keys of the tags being removed from the resource.

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.

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

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Service Reference:

Examples:

Calling the updateGlobalSettings operation

var params = {
  VoiceConnector: {
    CdrBucket: 'STRING_VALUE'
  }
};
chimesdkvoice.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: {})
    • VoiceConnector — (map)

      The Voice Connector settings.

      • CdrBucket — (String)

        The S3 bucket that stores the Voice Connector's call detail records.

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 or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Service Reference:

Examples:

Calling the updatePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  CallingName: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  ProductType: VoiceConnector | SipMediaApplicationDialIn
};
chimesdkvoice.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:
      • "VoiceConnector"
      • "SipMediaApplicationDialIn"
    • CallingName — (String)

      The outbound calling name associated with the phone number.

    • Name — (String)

      Specifies the name assigned to one or more phone numbers.

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's ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Country — (String)

          The phone number's country. Format: ISO 3166-1 alpha-2.

        • Type — (String)

          The phone number's type.

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

          The phone number's product type.

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

          The phone number's status.

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

          The phone number's 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 inbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number's associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

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

            Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

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

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • 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.

        • OrderId — (String)

          The phone number's order ID.

        • Name — (String)

          The name of the phone number.

Returns:

  • (AWS.Request)

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

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

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Service Reference:

Examples:

Calling the updatePhoneNumberSettings operation

var params = {
  CallingName: 'STRING_VALUE' /* required */
};
chimesdkvoice.updatePhoneNumberSettings(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: {})
    • CallingName — (String)

      The default outbound calling name for the 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.

Returns:

  • (AWS.Request)

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

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

Updates the specified proxy session details, such as voice or SMS capabilities.

Service Reference:

Examples:

Calling the updateProxySession operation

var params = {
  Capabilities: [ /* required */
    Voice | SMS,
    /* more items */
  ],
  ProxySessionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ExpiryMinutes: 'NUMBER_VALUE'
};
chimesdkvoice.updateProxySession(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 Voice Connector ID.

    • ProxySessionId — (String)

      The proxy session ID.

    • Capabilities — (Array<String>)

      The proxy session capabilities.

    • ExpiryMinutes — (Integer)

      The number of minutes allowed for the proxy session.

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:

      • ProxySession — (map)

        The updated proxy session details.

        • VoiceConnectorId — (String)

          The Voice Connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The proxy session name.

        • Status — (String)

          The proxy session status.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

Returns:

  • (AWS.Request)

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

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

Updates the details of the specified SIP media application.

Service Reference:

Examples:

Calling the updateSipMediaApplication operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  Endpoints: [
    {
      LambdaArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE'
};
chimesdkvoice.updateSipMediaApplication(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

    • Name — (String)

      The new name for the specified SIP media application.

    • Endpoints — (Array<map>)

      The new set of endpoints for the specified SIP media application.

      • LambdaArn — (String)

        Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

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:

      • SipMediaApplication — (map)

        The updated SIP media application’s details.

        • SipMediaApplicationId — (String)

          A SIP media application's ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The SIP media application's name.

        • Endpoints — (Array<map>)

          List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP media application was updated.

        • SipMediaApplicationArn — (String)

          The ARN of the SIP media application.

Returns:

  • (AWS.Request)

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

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

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

Service Reference:

Examples:

Calling the updateSipMediaApplicationCall operation

var params = {
  Arguments: { /* required */
    '<SensitiveString>': 'STRING_VALUE',
    /* '<SensitiveString>': ... */
  },
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  TransactionId: 'STRING_VALUE' /* required */
};
chimesdkvoice.updateSipMediaApplicationCall(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: {})
    • SipMediaApplicationId — (String)

      The ID of the SIP media application handling the call.

    • TransactionId — (String)

      The ID of the call transaction.

    • Arguments — (map<String>)

      Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

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:

      • SipMediaApplicationCall — (map)

        A Call instance for a SIP media application.

        • TransactionId — (String)

          The call's transaction ID.

Returns:

  • (AWS.Request)

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

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

Updates the details of the specified SIP rule.

Service Reference:

Examples:

Calling the updateSipRule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SipRuleId: 'STRING_VALUE', /* required */
  Disabled: true || false,
  TargetApplications: [
    {
      AwsRegion: 'STRING_VALUE',
      Priority: 'NUMBER_VALUE',
      SipMediaApplicationId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chimesdkvoice.updateSipRule(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: {})
    • SipRuleId — (String)

      The SIP rule ID.

    • Name — (String)

      The new name for the specified SIP rule.

    • Disabled — (Boolean)

      The new value that indicates whether the rule is disabled.

    • TargetApplications — (Array<map>)

      The new list of target applications.

      • SipMediaApplicationId — (String)

        The ID of a rule's target SIP media application.

      • Priority — (Integer)

        The priority setting of a rule's target SIP media application.

      • AwsRegion — (String)

        The AWS Region of a rule's target SIP media application.

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:

      • SipRule — (map)

        The updated SIP rule details.

        • SipRuleId — (String)

          A SIP rule's ID.

        • Name — (String)

          A SIP rule's name.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger set for a SIP rule, either a phone number or a URI request host name.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

        • TargetApplications — (Array<map>)

          The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The ID of a rule's target SIP media application.

          • Priority — (Integer)

            The priority setting of a rule's target SIP media application.

          • AwsRegion — (String)

            The AWS Region of a rule's target SIP media application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Updates the details for the specified Amazon Chime SDK Voice Connector.

Service Reference:

Examples:

Calling the updateVoiceConnector operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RequireEncryption: true || false, /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chimesdkvoice.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 Voice Connector ID.

    • Name — (String)

      The name of the Voice Connector.

    • RequireEncryption — (Boolean)

      When enabled, requires encryption for the 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 updated Voice Connector details.

        • VoiceConnectorId — (String)

          The Voice Connector's ID.

        • AwsRegion — (String)

          The AWS Region in which the Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
          • "ca-central-1"
          • "eu-central-1"
          • "eu-west-1"
          • "eu-west-2"
          • "ap-northeast-2"
          • "ap-northeast-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
        • Name — (String)

          The Voice Connector's name.

        • OutboundHostName — (String)

          The outbound host name for the Voice Connector.

        • RequireEncryption — (Boolean)

          Enables or disables encryption for the Voice Connector.

        • CreatedTimestamp — (Date)

          The Voice Connector's creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector's updated timestamp, in ISO 8601 format.

        • VoiceConnectorArn — (String)

          The ARN of the Voice Connector.

Returns:

  • (AWS.Request)

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

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

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

Service Reference:

Examples:

Calling the updateVoiceConnectorGroup operation

var params = {
  Name: 'STRING_VALUE', /* required */
  VoiceConnectorGroupId: 'STRING_VALUE', /* required */
  VoiceConnectorItems: [ /* required */
    {
      Priority: 'NUMBER_VALUE', /* required */
      VoiceConnectorId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.updateVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Voice Connector ID.

    • Name — (String)

      The name of the Voice Connector group.

    • VoiceConnectorItems — (Array<map>)

      The VoiceConnectorItems to associate with the Voice Connector group.

      • VoiceConnectorIdrequired — (String)

        The Voice Connector ID.

      • Priorityrequired — (Integer)

        The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

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:

      • VoiceConnectorGroup — (map)

        The updated Voice Connector group.

        • VoiceConnectorGroupId — (String)

          The ID of a Voice Connector group.

        • Name — (String)

          The name of a Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Voice Connectors to which you route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

        • CreatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • VoiceConnectorGroupArn — (String)

          The ARN of the Voice Connector group.

Returns:

  • (AWS.Request)

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

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

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

Service Reference:

Examples:

Calling the updateVoiceProfile operation

var params = {
  SpeakerSearchTaskId: 'STRING_VALUE', /* required */
  VoiceProfileId: 'STRING_VALUE' /* required */
};
chimesdkvoice.updateVoiceProfile(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: {})
    • VoiceProfileId — (String)

      The profile ID.

    • SpeakerSearchTaskId — (String)

      The ID of the speaker search task.

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:

      • VoiceProfile — (map)

        The updated voice profile settings.

        • VoiceProfileId — (String)

          The ID of the voice profile.

        • VoiceProfileArn — (String)

          The ARN of the voice profile.

        • VoiceProfileDomainId — (String)

          The ID of the domain that contains the voice profile.

        • CreatedTimestamp — (Date)

          The time at which the voice profile was created and enrolled.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile was last updated.

        • ExpirationTimestamp — (Date)

          The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

Returns:

  • (AWS.Request)

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

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

Updates the settings for the specified voice profile domain.

Service Reference:

Examples:

Calling the updateVoiceProfileDomain operation

var params = {
  VoiceProfileDomainId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
chimesdkvoice.updateVoiceProfileDomain(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: {})
    • VoiceProfileDomainId — (String)

      The domain ID.

    • Name — (String)

      The name of the voice profile domain.

    • Description — (String)

      The description of the voice profile domain.

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:

      • VoiceProfileDomain — (map)

        The updated details of the voice profile domain.

        • VoiceProfileDomainId — (String)

          The ID of the voice profile domain.

        • VoiceProfileDomainArn — (String)

          The voice profile domain's Amazon Resource Number (ARN).

        • Name — (String)

          The name of the voice profile domain.

        • Description — (String)

          The description of the voice profile domain.

        • ServerSideEncryptionConfiguration — (map)

          A structure that contains the configuration settings for server-side encryption.

          • KmsKeyArnrequired — (String)

            The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

        • CreatedTimestamp — (Date)

          The time at which the voice profile domain was created.

        • UpdatedTimestamp — (Date)

          The time at which the voice profile was last updated.

Returns:

  • (AWS.Request)

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

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

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Service Reference:

Examples:

Calling the validateE911Address operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  City: 'STRING_VALUE', /* required */
  Country: 'STRING_VALUE', /* required */
  PostalCode: 'STRING_VALUE', /* required */
  State: 'STRING_VALUE', /* required */
  StreetInfo: 'STRING_VALUE', /* required */
  StreetNumber: 'STRING_VALUE' /* required */
};
chimesdkvoice.validateE911Address(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: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • StreetNumber — (String)

      The address street number, such as 200 or 2121.

    • StreetInfo — (String)

      The address street information, such as 8th Avenue.

    • City — (String)

      The address city, such as Portland.

    • State — (String)

      The address state, such as ME.

    • Country — (String)

      The country in the address being validated.

    • PostalCode — (String)

      The dress postal code, such 04352.

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:

      • ValidationResult — (Integer)

        Number indicating the result of address validation. 0 means the address was perfect as-is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

      • AddressExternalId — (String)

        The ID that represents the address.

      • Address — (map)

        The validated address.

        • streetName — (String)

          The address street, such as 8th Avenue.

        • streetSuffix — (String)

          The address suffix, such as the N in 8th Avenue N.

        • postDirectional — (String)

          An address suffix location, such as the S. Unit A in Central Park S. Unit A.

        • preDirectional — (String)

          An address prefix location, such as the N in N. Third St.

        • streetNumber — (String)

          The numeric portion of an address.

        • city — (String)

          The city of an address.

        • state — (String)

          The state of an address.

        • postalCode — (String)

          The postal code of an address.

        • postalCodePlus4 — (String)

          The zip + 4 or postal code + 4 of an address.

        • country — (String)

          The country of an address.

      • CandidateAddressList — (Array<map>)

        The list of address suggestions..

        • streetInfo — (String)

          The street information of the candidate address.

        • streetNumber — (String)

          The numeric portion of the candidate address.

        • city — (String)

          The city of the candidate address.

        • state — (String)

          The state of the candidate address.

        • postalCode — (String)

          The postal code of the candidate address.

        • postalCodePlus4 — (String)

          The zip + 4 or postal code +4 of the candidate address.

        • country — (String)

          The country of the candidate address.

Returns:

  • (AWS.Request)

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