You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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.

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

Calls the AssociatePhoneNumbersWithVoiceConnector API operation.

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)
    • E164PhoneNumbers — (Array<String>)
    • ForceAssociate — (Boolean)

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

Returns:

  • (AWS.Request)

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

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

Calls the AssociatePhoneNumbersWithVoiceConnectorGroup API operation.

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)
    • E164PhoneNumbers — (Array<String>)
    • ForceAssociate — (Boolean)

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

Returns:

  • (AWS.Request)

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

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

Calls the BatchDeletePhoneNumber API operation.

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>)

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

Returns:

  • (AWS.Request)

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

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

Calls the BatchUpdatePhoneNumber API operation.

Service Reference:

Examples:

Calling the batchUpdatePhoneNumber operation

var params = {
  UpdatePhoneNumberRequestItems: [ /* required */
    {
      PhoneNumberId: 'STRING_VALUE', /* required */
      CallingName: '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>)
      • PhoneNumberIdrequired — (String)
      • ProductType — (String) Possible values include:
        • "VoiceConnector"
        • "SipMediaApplicationDialIn"
      • CallingName — (String)

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

Returns:

  • (AWS.Request)

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

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

Calls the CreatePhoneNumberOrder API operation.

Service Reference:

Examples:

Calling the createPhoneNumberOrder operation

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

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)
        • PhoneNumberOrderId — (String)
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
          • "PendingDocuments"
          • "Submitted"
          • "FOC"
          • "ChangeRequested"
          • "Exception"
          • "CancelRequested"
          • "Cancelled"
        • OrderType — (String) Possible values include:
          • "New"
          • "Porting"
        • OrderedPhoneNumbers — (Array<map>)
          • E164PhoneNumber — (String)
          • Status — (String) Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the CreateProxySession API operation.

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)
    • ParticipantPhoneNumbers — (Array<String>)
    • Name — (String)
    • ExpiryMinutes — (Integer)
    • Capabilities — (Array<String>)
    • NumberSelectionBehavior — (String) Possible values include:
      • "PreferSticky"
      • "AvoidSticky"
    • GeoMatchLevel — (String) Possible values include:
      • "Country"
      • "AreaCode"
    • GeoMatchParams — (map)
      • Countryrequired — (String)
      • AreaCoderequired — (String)

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)
        • VoiceConnectorId — (String)
        • ProxySessionId — (String)
        • Name — (String)
        • Status — (String) Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)
        • Capabilities — (Array<String>)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • EndedTimestamp — (Date)
        • Participants — (Array<map>)
          • PhoneNumber — (String)
          • ProxyPhoneNumber — (String)
        • NumberSelectionBehavior — (String) Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String) Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)
          • Countryrequired — (String)
          • AreaCoderequired — (String)

Returns:

  • (AWS.Request)

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

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

Calls the CreateSipMediaApplication API operation.

Service Reference:

Examples:

Calling the createSipMediaApplication operation

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

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)
        • SipMediaApplicationId — (String)
        • AwsRegion — (String)
        • Name — (String)
        • Endpoints — (Array<map>)
          • LambdaArn — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the CreateSipMediaApplicationCall API operation.

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)
    • ToPhoneNumber — (String)
    • SipMediaApplicationId — (String)
    • SipHeaders — (map<String>)
    • ArgumentsMap — (map<String>)

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)
        • TransactionId — (String)

Returns:

  • (AWS.Request)

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

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

Calls the CreateSipRule API operation.

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)
    • TriggerType — (String) Possible values include:
      • "ToPhoneNumber"
      • "RequestUriHostname"
    • TriggerValue — (String)
    • Disabled — (Boolean)
    • TargetApplications — (Array<map>)
      • SipMediaApplicationId — (String)
      • Priority — (Integer)
      • AwsRegion — (String)

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)
        • SipRuleId — (String)
        • Name — (String)
        • Disabled — (Boolean)
        • TriggerType — (String) Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)
        • TargetApplications — (Array<map>)
          • SipMediaApplicationId — (String)
          • Priority — (Integer)
          • AwsRegion — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the CreateVoiceConnector API operation.

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
};
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)
    • AwsRegion — (String) 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)

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)
        • VoiceConnectorId — (String)
        • AwsRegion — (String) 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)
        • OutboundHostName — (String)
        • RequireEncryption — (Boolean)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorArn — (String)

Returns:

  • (AWS.Request)

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

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

Calls the CreateVoiceConnectorGroup API operation.

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)
    • VoiceConnectorItems — (Array<map>)
      • VoiceConnectorIdrequired — (String)
      • Priorityrequired — (Integer)

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)
        • VoiceConnectorGroupId — (String)
        • Name — (String)
        • VoiceConnectorItems — (Array<map>)
          • VoiceConnectorIdrequired — (String)
          • Priorityrequired — (Integer)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorGroupArn — (String)

Returns:

  • (AWS.Request)

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

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

Calls the DeletePhoneNumber API operation.

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)

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

Calls the DeleteProxySession API operation.

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)
    • ProxySessionId — (String)

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

Calls the DeleteSipMediaApplication API operation.

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)

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

Calls the DeleteSipRule API operation.

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)

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

Calls the DeleteVoiceConnector API operation.

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)

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

Calls the DeleteVoiceConnectorEmergencyCallingConfiguration API operation.

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)

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

Calls the DeleteVoiceConnectorGroup API operation.

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)

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

Calls the DeleteVoiceConnectorOrigination API operation.

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)

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

Calls the DeleteVoiceConnectorProxy API operation.

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)

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

Calls the DeleteVoiceConnectorStreamingConfiguration API operation.

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)

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

Calls the DeleteVoiceConnectorTermination API operation.

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)

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

Calls the DeleteVoiceConnectorTerminationCredentials API operation.

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)
    • Usernames — (Array<String>)

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

Calls the DisassociatePhoneNumbersFromVoiceConnector API operation.

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)
    • E164PhoneNumbers — (Array<String>)

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

Returns:

  • (AWS.Request)

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

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

Calls the DisassociatePhoneNumbersFromVoiceConnectorGroup API operation.

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)
    • E164PhoneNumbers — (Array<String>)

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

Returns:

  • (AWS.Request)

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

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

Calls the GetGlobalSettings API operation.

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)
        • CdrBucket — (String)

Returns:

  • (AWS.Request)

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

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

Calls the GetPhoneNumber API operation.

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)

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)
        • PhoneNumberId — (String)
        • E164PhoneNumber — (String)
        • Country — (String)
        • Type — (String) Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Cancelled"
          • "PortinCancelRequested"
          • "PortinInProgress"
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)
          • InboundCall — (Boolean)
          • OutboundCall — (Boolean)
          • InboundSMS — (Boolean)
          • OutboundSMS — (Boolean)
          • InboundMMS — (Boolean)
          • OutboundMMS — (Boolean)
        • Associations — (Array<map>)
          • Value — (String)
          • Name — (String) Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)
        • CallingName — (String)
        • CallingNameStatus — (String) Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • DeletionTimestamp — (Date)
        • OrderId — (String)

Returns:

  • (AWS.Request)

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

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

Calls the GetPhoneNumberOrder API operation.

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)

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)
        • PhoneNumberOrderId — (String)
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
          • "PendingDocuments"
          • "Submitted"
          • "FOC"
          • "ChangeRequested"
          • "Exception"
          • "CancelRequested"
          • "Cancelled"
        • OrderType — (String) Possible values include:
          • "New"
          • "Porting"
        • OrderedPhoneNumbers — (Array<map>)
          • E164PhoneNumber — (String)
          • Status — (String) Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the GetPhoneNumberSettings API operation.

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)
      • CallingNameUpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the GetProxySession API operation.

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)
    • ProxySessionId — (String)

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)
        • VoiceConnectorId — (String)
        • ProxySessionId — (String)
        • Name — (String)
        • Status — (String) Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)
        • Capabilities — (Array<String>)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • EndedTimestamp — (Date)
        • Participants — (Array<map>)
          • PhoneNumber — (String)
          • ProxyPhoneNumber — (String)
        • NumberSelectionBehavior — (String) Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String) Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)
          • Countryrequired — (String)
          • AreaCoderequired — (String)

Returns:

  • (AWS.Request)

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

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

Calls the GetSipMediaApplication API operation.

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)

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)
        • SipMediaApplicationId — (String)
        • AwsRegion — (String)
        • Name — (String)
        • Endpoints — (Array<map>)
          • LambdaArn — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the GetSipMediaApplicationAlexaSkillConfiguration API operation.

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)

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)
        • AlexaSkillStatusrequired — (String) Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • AlexaSkillIdsrequired — (Array<String>)

Returns:

  • (AWS.Request)

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

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

Calls the GetSipMediaApplicationLoggingConfiguration API operation.

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)

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)
        • EnableSipMediaApplicationMessageLogs — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the GetSipRule API operation.

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)

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)
        • SipRuleId — (String)
        • Name — (String)
        • Disabled — (Boolean)
        • TriggerType — (String) Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)
        • TargetApplications — (Array<map>)
          • SipMediaApplicationId — (String)
          • Priority — (Integer)
          • AwsRegion — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnector API operation.

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)

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)
        • VoiceConnectorId — (String)
        • AwsRegion — (String) 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)
        • OutboundHostName — (String)
        • RequireEncryption — (Boolean)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorArn — (String)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorEmergencyCallingConfiguration API operation.

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)

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)
        • DNIS — (Array<map>)
          • EmergencyPhoneNumberrequired — (String)
          • TestPhoneNumber — (String)
          • CallingCountryrequired — (String)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorGroup API operation.

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)

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)
        • VoiceConnectorGroupId — (String)
        • Name — (String)
        • VoiceConnectorItems — (Array<map>)
          • VoiceConnectorIdrequired — (String)
          • Priorityrequired — (Integer)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorGroupArn — (String)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorLoggingConfiguration API operation.

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)

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)
        • EnableSIPLogs — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorOrigination API operation.

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)

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)
        • Routes — (Array<map>)
          • Host — (String)
          • Port — (Integer)
          • Protocol — (String) Possible values include:
            • "TCP"
            • "UDP"
          • Priority — (Integer)
          • Weight — (Integer)
        • Disabled — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorProxy API operation.

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)

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)
        • DefaultSessionExpiryMinutes — (Integer)
        • Disabled — (Boolean)
        • FallBackPhoneNumber — (String)
        • PhoneNumberCountries — (Array<String>)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorStreamingConfiguration API operation.

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)

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)
        • DataRetentionInHoursrequired — (Integer)
        • Disabledrequired — (Boolean)
        • StreamingNotificationTargets — (Array<map>)
          • NotificationTarget — (String) Possible values include:
            • "EventBridge"
            • "SNS"
            • "SQS"

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorTermination API operation.

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)

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)
        • CpsLimit — (Integer)
        • DefaultPhoneNumber — (String)
        • CallingRegions — (Array<String>)
        • CidrAllowedList — (Array<String>)
        • Disabled — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the GetVoiceConnectorTerminationHealth API operation.

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)

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)
        • Timestamp — (Date)
        • Source — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListAvailableVoiceConnectorRegions API operation.

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>)

Returns:

  • (AWS.Request)

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

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

Calls the ListPhoneNumberOrders API operation.

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)
    • MaxResults — (Integer)

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>)
        • PhoneNumberOrderId — (String)
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
          • "PendingDocuments"
          • "Submitted"
          • "FOC"
          • "ChangeRequested"
          • "Exception"
          • "CancelRequested"
          • "Cancelled"
        • OrderType — (String) Possible values include:
          • "New"
          • "Porting"
        • OrderedPhoneNumbers — (Array<map>)
          • E164PhoneNumber — (String)
          • Status — (String) Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListPhoneNumbers API operation.

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)
    • ProductType — (String) Possible values include:
      • "VoiceConnector"
      • "SipMediaApplicationDialIn"
    • FilterName — (String) Possible values include:
      • "VoiceConnectorId"
      • "VoiceConnectorGroupId"
      • "SipRuleId"
    • FilterValue — (String)
    • MaxResults — (Integer)
    • NextToken — (String)

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>)
        • PhoneNumberId — (String)
        • E164PhoneNumber — (String)
        • Country — (String)
        • Type — (String) Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Cancelled"
          • "PortinCancelRequested"
          • "PortinInProgress"
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)
          • InboundCall — (Boolean)
          • OutboundCall — (Boolean)
          • InboundSMS — (Boolean)
          • OutboundSMS — (Boolean)
          • InboundMMS — (Boolean)
          • OutboundMMS — (Boolean)
        • Associations — (Array<map>)
          • Value — (String)
          • Name — (String) Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)
        • CallingName — (String)
        • CallingNameStatus — (String) Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • DeletionTimestamp — (Date)
        • OrderId — (String)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListProxySessions API operation.

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)
    • Status — (String) Possible values include:
      • "Open"
      • "InProgress"
      • "Closed"
    • NextToken — (String)
    • MaxResults — (Integer)

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>)
        • VoiceConnectorId — (String)
        • ProxySessionId — (String)
        • Name — (String)
        • Status — (String) Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)
        • Capabilities — (Array<String>)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • EndedTimestamp — (Date)
        • Participants — (Array<map>)
          • PhoneNumber — (String)
          • ProxyPhoneNumber — (String)
        • NumberSelectionBehavior — (String) Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String) Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)
          • Countryrequired — (String)
          • AreaCoderequired — (String)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListSipMediaApplications API operation.

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)
    • NextToken — (String)

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>)
        • SipMediaApplicationId — (String)
        • AwsRegion — (String)
        • Name — (String)
        • Endpoints — (Array<map>)
          • LambdaArn — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListSipRules API operation.

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)
    • MaxResults — (Integer)
    • NextToken — (String)

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>)
        • SipRuleId — (String)
        • Name — (String)
        • Disabled — (Boolean)
        • TriggerType — (String) Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)
        • TargetApplications — (Array<map>)
          • SipMediaApplicationId — (String)
          • Priority — (Integer)
          • AwsRegion — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListSupportedPhoneNumberCountries API operation.

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) 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>)
        • CountryCode — (String)
        • SupportedPhoneNumberTypes — (Array<String>)

Returns:

  • (AWS.Request)

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

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

Calls the ListVoiceConnectorGroups API operation.

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)
    • MaxResults — (Integer)

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>)
        • VoiceConnectorGroupId — (String)
        • Name — (String)
        • VoiceConnectorItems — (Array<map>)
          • VoiceConnectorIdrequired — (String)
          • Priorityrequired — (Integer)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorGroupArn — (String)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListVoiceConnectors API operation.

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)
    • MaxResults — (Integer)

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>)
        • VoiceConnectorId — (String)
        • AwsRegion — (String) 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)
        • OutboundHostName — (String)
        • RequireEncryption — (Boolean)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorArn — (String)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListVoiceConnectorTerminationCredentials API operation.

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)

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>)

Returns:

  • (AWS.Request)

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

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

Calls the PutSipMediaApplicationAlexaSkillConfiguration API operation.

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)
    • SipMediaApplicationAlexaSkillConfiguration — (map)
      • AlexaSkillStatusrequired — (String) Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • AlexaSkillIdsrequired — (Array<String>)

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)
        • AlexaSkillStatusrequired — (String) Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • AlexaSkillIdsrequired — (Array<String>)

Returns:

  • (AWS.Request)

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

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

Calls the PutSipMediaApplicationLoggingConfiguration API operation.

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)
    • SipMediaApplicationLoggingConfiguration — (map)
      • EnableSipMediaApplicationMessageLogs — (Boolean)

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)
        • EnableSipMediaApplicationMessageLogs — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorEmergencyCallingConfiguration API operation.

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)
    • EmergencyCallingConfiguration — (map)
      • DNIS — (Array<map>)
        • EmergencyPhoneNumberrequired — (String)
        • TestPhoneNumber — (String)
        • CallingCountryrequired — (String)

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)
        • DNIS — (Array<map>)
          • EmergencyPhoneNumberrequired — (String)
          • TestPhoneNumber — (String)
          • CallingCountryrequired — (String)

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorLoggingConfiguration API operation.

Examples:

Calling the putVoiceConnectorLoggingConfiguration operation

var params = {
  LoggingConfiguration: { /* required */
    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)
    • LoggingConfiguration — (map)
      • EnableSIPLogs — (Boolean)

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)
        • EnableSIPLogs — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorOrigination API operation.

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)
    • Origination — (map)
      • Routes — (Array<map>)
        • Host — (String)
        • Port — (Integer)
        • Protocol — (String) Possible values include:
          • "TCP"
          • "UDP"
        • Priority — (Integer)
        • Weight — (Integer)
      • Disabled — (Boolean)

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)
        • Routes — (Array<map>)
          • Host — (String)
          • Port — (Integer)
          • Protocol — (String) Possible values include:
            • "TCP"
            • "UDP"
          • Priority — (Integer)
          • Weight — (Integer)
        • Disabled — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorProxy API operation.

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)
    • DefaultSessionExpiryMinutes — (Integer)
    • PhoneNumberPoolCountries — (Array<String>)
    • FallBackPhoneNumber — (String)
    • Disabled — (Boolean)

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)
        • DefaultSessionExpiryMinutes — (Integer)
        • Disabled — (Boolean)
        • FallBackPhoneNumber — (String)
        • PhoneNumberCountries — (Array<String>)

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorStreamingConfiguration API operation.

Examples:

Calling the putVoiceConnectorStreamingConfiguration operation

var params = {
  StreamingConfiguration: { /* required */
    DataRetentionInHours: 'NUMBER_VALUE', /* required */
    Disabled: true || false, /* required */
    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)
    • StreamingConfiguration — (map)
      • DataRetentionInHoursrequired — (Integer)
      • Disabledrequired — (Boolean)
      • StreamingNotificationTargets — (Array<map>)
        • NotificationTarget — (String) Possible values include:
          • "EventBridge"
          • "SNS"
          • "SQS"

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)
        • DataRetentionInHoursrequired — (Integer)
        • Disabledrequired — (Boolean)
        • StreamingNotificationTargets — (Array<map>)
          • NotificationTarget — (String) Possible values include:
            • "EventBridge"
            • "SNS"
            • "SQS"

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorTermination API operation.

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)
    • Termination — (map)
      • CpsLimit — (Integer)
      • DefaultPhoneNumber — (String)
      • CallingRegions — (Array<String>)
      • CidrAllowedList — (Array<String>)
      • Disabled — (Boolean)

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)
        • CpsLimit — (Integer)
        • DefaultPhoneNumber — (String)
        • CallingRegions — (Array<String>)
        • CidrAllowedList — (Array<String>)
        • Disabled — (Boolean)

Returns:

  • (AWS.Request)

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

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

Calls the PutVoiceConnectorTerminationCredentials API operation.

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)
    • Credentials — (Array<map>)
      • Username — (String)
      • Password — (String)

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

Calls the RestorePhoneNumber API operation.

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)

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)
        • PhoneNumberId — (String)
        • E164PhoneNumber — (String)
        • Country — (String)
        • Type — (String) Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Cancelled"
          • "PortinCancelRequested"
          • "PortinInProgress"
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)
          • InboundCall — (Boolean)
          • OutboundCall — (Boolean)
          • InboundSMS — (Boolean)
          • OutboundSMS — (Boolean)
          • InboundMMS — (Boolean)
          • OutboundMMS — (Boolean)
        • Associations — (Array<map>)
          • Value — (String)
          • Name — (String) Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)
        • CallingName — (String)
        • CallingNameStatus — (String) Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • DeletionTimestamp — (Date)
        • OrderId — (String)

Returns:

  • (AWS.Request)

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

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

Calls the SearchAvailablePhoneNumbers API operation.

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)
    • City — (String)
    • Country — (String)
    • State — (String)
    • TollFreePrefix — (String)
    • PhoneNumberType — (String) Possible values include:
      • "Local"
      • "TollFree"
    • MaxResults — (Integer)
    • NextToken — (String)

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>)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the UpdateGlobalSettings API operation.

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)
      • CdrBucket — (String)

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

Calls the UpdatePhoneNumber API operation.

Service Reference:

Examples:

Calling the updatePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  CallingName: '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)
    • ProductType — (String) Possible values include:
      • "VoiceConnector"
      • "SipMediaApplicationDialIn"
    • CallingName — (String)

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)
        • PhoneNumberId — (String)
        • E164PhoneNumber — (String)
        • Country — (String)
        • Type — (String) Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String) Possible values include:
          • "VoiceConnector"
          • "SipMediaApplicationDialIn"
        • Status — (String) Possible values include:
          • "Cancelled"
          • "PortinCancelRequested"
          • "PortinInProgress"
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)
          • InboundCall — (Boolean)
          • OutboundCall — (Boolean)
          • InboundSMS — (Boolean)
          • OutboundSMS — (Boolean)
          • InboundMMS — (Boolean)
          • OutboundMMS — (Boolean)
        • Associations — (Array<map>)
          • Value — (String)
          • Name — (String) Possible values include:
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)
        • CallingName — (String)
        • CallingNameStatus — (String) Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • DeletionTimestamp — (Date)
        • OrderId — (String)

Returns:

  • (AWS.Request)

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

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

Calls the UpdatePhoneNumberSettings API operation.

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)

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

Calls the UpdateProxySession API operation.

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)
    • ProxySessionId — (String)
    • Capabilities — (Array<String>)
    • ExpiryMinutes — (Integer)

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)
        • VoiceConnectorId — (String)
        • ProxySessionId — (String)
        • Name — (String)
        • Status — (String) Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)
        • Capabilities — (Array<String>)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • EndedTimestamp — (Date)
        • Participants — (Array<map>)
          • PhoneNumber — (String)
          • ProxyPhoneNumber — (String)
        • NumberSelectionBehavior — (String) Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String) Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)
          • Countryrequired — (String)
          • AreaCoderequired — (String)

Returns:

  • (AWS.Request)

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

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

Calls the UpdateSipMediaApplication API operation.

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)
    • Name — (String)
    • Endpoints — (Array<map>)
      • LambdaArn — (String)

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)
        • SipMediaApplicationId — (String)
        • AwsRegion — (String)
        • Name — (String)
        • Endpoints — (Array<map>)
          • LambdaArn — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the UpdateSipMediaApplicationCall API operation.

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)
    • TransactionId — (String)
    • Arguments — (map<String>)

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)
        • TransactionId — (String)

Returns:

  • (AWS.Request)

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

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

Calls the UpdateSipRule API operation.

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)
    • Name — (String)
    • Disabled — (Boolean)
    • TargetApplications — (Array<map>)
      • SipMediaApplicationId — (String)
      • Priority — (Integer)
      • AwsRegion — (String)

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)
        • SipRuleId — (String)
        • Name — (String)
        • Disabled — (Boolean)
        • TriggerType — (String) Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)
        • TargetApplications — (Array<map>)
          • SipMediaApplicationId — (String)
          • Priority — (Integer)
          • AwsRegion — (String)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)

Returns:

  • (AWS.Request)

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

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

Calls the UpdateVoiceConnector API operation.

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)
    • Name — (String)
    • RequireEncryption — (Boolean)

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)
        • VoiceConnectorId — (String)
        • AwsRegion — (String) 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)
        • OutboundHostName — (String)
        • RequireEncryption — (Boolean)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorArn — (String)

Returns:

  • (AWS.Request)

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

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

Calls the UpdateVoiceConnectorGroup API operation.

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)
    • Name — (String)
    • VoiceConnectorItems — (Array<map>)
      • VoiceConnectorIdrequired — (String)
      • Priorityrequired — (Integer)

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)
        • VoiceConnectorGroupId — (String)
        • Name — (String)
        • VoiceConnectorItems — (Array<map>)
          • VoiceConnectorIdrequired — (String)
          • Priorityrequired — (Integer)
        • CreatedTimestamp — (Date)
        • UpdatedTimestamp — (Date)
        • VoiceConnectorGroupArn — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ValidateE911Address API operation.

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)
    • StreetNumber — (String)
    • StreetInfo — (String)
    • City — (String)
    • State — (String)
    • Country — (String)
    • PostalCode — (String)

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)
      • AddressExternalId — (String)
      • Address — (map)
        • streetName — (String)
        • streetSuffix — (String)
        • postDirectional — (String)
        • preDirectional — (String)
        • streetNumber — (String)
        • city — (String)
        • state — (String)
        • postalCode — (String)
        • postalCodePlus4 — (String)
        • country — (String)
      • CandidateAddressList — (Array<map>)
        • streetInfo — (String)
        • streetNumber — (String)
        • city — (String)
        • state — (String)
        • postalCode — (String)
        • postalCodePlus4 — (String)
        • country — (String)

Returns:

  • (AWS.Request)

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