Class: AWS.ChimeSDKVoice

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorGroupId: 'STRING_VALUE', /* required */
  ForceAssociate: true || false
};
chimesdkvoice.associatePhoneNumbersWithVoiceConnectorGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Amazon Chime SDK Voice Connector group ID.

  • E164PhoneNumbers — (Array<String>)

    List of phone numbers, in E.164 format.

  • ForceAssociate — (Boolean)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)

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

      • PhoneNumberId — (String)

        The phone number ID for which the action failed.

      • ErrorCode — (String)

        The error code.

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

        The error message.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    List of phone number IDs.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)

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

      • PhoneNumberId — (String)

        The phone number ID for which the action failed.

      • ErrorCode — (String)

        The error code.

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

        The error message.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    Lists the phone numbers in the update request.

    • PhoneNumberId — required — (String)

      The phone number ID to update.

    • ProductType — (String)

      The product type to update.

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

      The outbound calling name to update.

    • Name — (String)

      The name of the phone number.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)

      A list of failed phone numbers and their error messages.

      • PhoneNumberId — (String)

        The phone number ID for which the action failed.

      • ErrorCode — (String)

        The error code.

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

        The error message.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The phone number product type.

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

    List of phone numbers, in E.164 format.

  • Name — (String)

    Specifies the name assigned to one or more phone numbers.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberOrder — (map)

      The phone number order details.

      • PhoneNumberOrderId — (String)

        The ID of the phone order.

      • ProductType — (String)

        The phone number order product type.

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

        The status of the phone number order.

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

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

        Possible values include:
        • "New"
        • "Porting"
      • OrderedPhoneNumbers — (Array<map>)

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

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Status — (String)

          The phone number status.

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

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

      • UpdatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

var params = {
  Capabilities: [ /* required */
    Voice | SMS,
    /* more items */
  ],
  ParticipantPhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ExpiryMinutes: 'NUMBER_VALUE',
  GeoMatchLevel: Country | AreaCode,
  GeoMatchParams: {
    AreaCode: 'STRING_VALUE', /* required */
    Country: 'STRING_VALUE' /* required */
  },
  Name: 'STRING_VALUE',
  NumberSelectionBehavior: PreferSticky | AvoidSticky
};
chimesdkvoice.createProxySession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Voice Connector ID.

  • ParticipantPhoneNumbers — (Array<String>)

    The participant phone numbers.

  • Name — (String)

    The name of the proxy session.

  • ExpiryMinutes — (Integer)

    The number of minutes allowed for the proxy session.

  • Capabilities — (Array<String>)

    The proxy session's capabilities.

  • NumberSelectionBehavior — (String)

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

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

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

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

    The country and area code for the proxy phone number.

    • Country — required — (String)

      The country.

    • AreaCode — required — (String)

      The area code.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProxySession — (map)

      The proxy session details.

      • VoiceConnectorId — (String)

        The Voice Connector ID.

      • ProxySessionId — (String)

        The proxy session ID.

      • Name — (String)

        The proxy session name.

      • Status — (String)

        The proxy session status.

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

        The number of minutes allowed for the proxy session.

      • Capabilities — (Array<String>)

        The proxy session capabilities.

      • CreatedTimestamp — (Date)

        The created time stamp, in ISO 8601 format.

      • UpdatedTimestamp — (Date)

        The updated time stamp, in ISO 8601 format.

      • EndedTimestamp — (Date)

        The ended time stamp, in ISO 8601 format.

      • Participants — (Array<map>)

        The proxy session participants.

        • PhoneNumber — (String)

          The participant's phone number.

        • ProxyPhoneNumber — (String)

          The participant's proxy phone number.

      • NumberSelectionBehavior — (String)

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

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

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

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

        The country and area code for the proxy phone number.

        • Country — required — (String)

          The country.

        • AreaCode — required — (String)

          The area code.

Returns:

• (AWS.Request) —

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

var params = {
  AwsRegion: 'STRING_VALUE', /* required */
  Endpoints: [ /* required */
    {
      LambdaArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createSipMediaApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The AWS Region assigned to the SIP media application.

  • Name — (String)

    The SIP media application's name.

  • Endpoints — (Array<map>)

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

    • LambdaArn — (String)

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

  • Tags — (Array<map>)

    The tags assigned to the SIP media application.

    • Key — required — (String)

      The tag's key.

    • Value — required — (String)

      The tag's value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplication — (map)

      The SIP media application details.

      • SipMediaApplicationId — (String)

        A SIP media application's ID.

      • AwsRegion — (String)

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

      • Name — (String)

        The SIP media application's name.

      • Endpoints — (Array<map>)

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

        • LambdaArn — (String)

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

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

        The time at which the SIP media application was updated.

      • SipMediaApplicationArn — (String)

        The ARN of the SIP media application.

Returns:

• (AWS.Request) —

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

var params = {
  FromPhoneNumber: 'STRING_VALUE', /* required */
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  ToPhoneNumber: 'STRING_VALUE', /* required */
  ArgumentsMap: {
    '<SensitiveString>': 'STRING_VALUE',
    /* '<SensitiveString>': ... */
  },
  SipHeaders: {
    '<SensitiveString>': 'STRING_VALUE',
    /* '<SensitiveString>': ... */
  }
};
chimesdkvoice.createSipMediaApplicationCall(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

  • ToPhoneNumber — (String)

    The phone number that the service should call.

  • SipMediaApplicationId — (String)

    The ID of the SIP media application.

  • SipHeaders — (map<String>)

    The SIP headers added to an outbound call leg.

  • ArgumentsMap — (map<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplicationCall — (map)

      The actual call.

      • TransactionId — (String)

        The call's transaction ID.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  TriggerType: ToPhoneNumber | RequestUriHostname, /* required */
  TriggerValue: 'STRING_VALUE', /* required */
  Disabled: true || false,
  TargetApplications: [
    {
      AwsRegion: 'STRING_VALUE',
      Priority: 'NUMBER_VALUE',
      SipMediaApplicationId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chimesdkvoice.createSipRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the SIP rule.

  • TriggerType — (String)

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

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

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

  • Disabled — (Boolean)

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

  • TargetApplications — (Array<map>)

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

    • SipMediaApplicationId — (String)

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

    • Priority — (Integer)

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

    • AwsRegion — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipRule — (map)

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

      • SipRuleId — (String)

        A SIP rule's ID.

      • Name — (String)

        A SIP rule's name.

      • Disabled — (Boolean)

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

      • TriggerType — (String)

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

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

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

      • TargetApplications — (Array<map>)

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

        • SipMediaApplicationId — (String)

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

        • Priority — (Integer)

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

        • AwsRegion — (String)

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

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  RequireEncryption: true || false, /* required */
  AwsRegion: us-east-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1 | eu-west-2 | ap-northeast-2 | ap-northeast-1 | ap-southeast-1 | ap-southeast-2,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createVoiceConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the Voice Connector.

  • AwsRegion — (String)

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

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

    Enables or disables encryption for the Voice Connector.

  • Tags — (Array<map>)

    The tags assigned to the Voice Connector.

    • Key — required — (String)

      The tag's key.

    • Value — required — (String)

      The tag's value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnector — (map)

      The details of the Voice Connector.

      • VoiceConnectorId — (String)

        The Voice Connector's ID.

      • AwsRegion — (String)

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

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

        The Voice Connector's name.

      • OutboundHostName — (String)

        The outbound host name for the Voice Connector.

      • RequireEncryption — (Boolean)

        Enables or disables encryption for the Voice Connector.

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

      • VoiceConnectorArn — (String)

        The ARN of the Voice Connector.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  VoiceConnectorItems: [
    {
      Priority: 'NUMBER_VALUE', /* required */
      VoiceConnectorId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createVoiceConnectorGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the Voice Connector group.

  • VoiceConnectorItems — (Array<map>)

    Lists the Voice Connectors that inbound calls are routed to.

    • VoiceConnectorId — required — (String)

      The Voice Connector ID.

    • Priority — required — (Integer)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectorGroup — (map)

      The details of the Voice Connector group.

      • VoiceConnectorGroupId — (String)

        The ID of a Voice Connector group.

      • Name — (String)

        The name of a Voice Connector group.

      • VoiceConnectorItems — (Array<map>)

        The Voice Connectors to which you route inbound calls.

        • VoiceConnectorId — required — (String)

          The Voice Connector ID.

        • Priority — required — (Integer)

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

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

      • VoiceConnectorGroupArn — (String)

        The ARN of the Voice Connector group.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ID of the speaker search task.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceProfile — (map)

      The requested voice profile.

      • VoiceProfileId — (String)

        The ID of the voice profile.

      • VoiceProfileArn — (String)

        The ARN of the voice profile.

      • VoiceProfileDomainId — (String)

        The ID of the domain that contains the voice profile.

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

        The time at which the voice profile was last updated.

      • ExpirationTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  ServerSideEncryptionConfiguration: { /* required */
    KmsKeyArn: 'STRING_VALUE' /* required */
  },
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkvoice.createVoiceProfileDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the voice profile domain.

  • Description — (String)

    A description of the voice profile domain.

  • ServerSideEncryptionConfiguration — (map)

    The server-side encryption configuration for the request.

    • KmsKeyArn — required — (String)

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

  • ClientRequestToken — (String)

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

  • Tags — (Array<map>)

    The tags assigned to the domain.

    • Key — required — (String)

      The tag's key.

    • Value — required — (String)

      The tag's value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceProfileDomain — (map)

      The requested voice profile domain.

      • VoiceProfileDomainId — (String)

        The ID of the voice profile domain.

      • VoiceProfileDomainArn — (String)

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

      • Name — (String)

        The name of the voice profile domain.

      • Description — (String)

        The description of the voice profile domain.

      • ServerSideEncryptionConfiguration — (map)

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

        • KmsKeyArn — required — (String)

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

      • CreatedTimestamp — (Date)

        The time at which the voice profile domain was created.

      • UpdatedTimestamp — (Date)

        The time at which the voice profile was last updated.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The phone number ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

  • ProxySessionId — (String)

    The proxy session ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The SIP media application ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The SIP rule ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector Group ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

  • Usernames — (Array<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The voice profile ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The voice profile domain ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

  • E164PhoneNumbers — (Array<String>)

    List of phone numbers, in E.164 format.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)

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

      • PhoneNumberId — (String)

        The phone number ID for which the action failed.

      • ErrorCode — (String)

        The error code.

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

        The error message.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector group ID.

  • E164PhoneNumbers — (Array<String>)

    The list of phone numbers, in E.164 format.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)

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

      • PhoneNumberId — (String)

        The phone number ID for which the action failed.

      • ErrorCode — (String)

        The error code.

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

        The error message.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnector — (map)

      The Voice Connector settings.

      • CdrBucket — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The phone number ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumber — (map)

      The phone number details.

      • PhoneNumberId — (String)

        The phone number's ID.

      • E164PhoneNumber — (String)

        The phone number, in E.164 format.

      • Country — (String)

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

      • Type — (String)

        The phone number's type.

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

        The phone number's product type.

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

        The phone number's status.

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

        The phone number's capabilities.

        • InboundCall — (Boolean)

          Allows or denies inbound calling for the specified phone number.

        • OutboundCall — (Boolean)

          Allows or denies outbound calling for the specified phone number.

        • InboundSMS — (Boolean)

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

        • OutboundSMS — (Boolean)

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

        • InboundMMS — (Boolean)

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

        • OutboundMMS — (Boolean)

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

      • Associations — (Array<map>)

        The phone number's associations.

        • Value — (String)

          Contains the ID for the entity specified in Name.

        • Name — (String)

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

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

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

      • CallingName — (String)

        The outbound calling name associated with the phone number.

      • CallingNameStatus — (String)

        The outbound calling name status.

        Possible values include:
        • "Unassigned"
        • "UpdateInProgress"
        • "UpdateSucceeded"
        • "UpdateFailed"
      • CreatedTimestamp — (Date)

        The phone number creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp — (Date)

        The updated phone number timestamp, in ISO 8601 format.

      • DeletionTimestamp — (Date)

        The deleted phone number timestamp, in ISO 8601 format.

      • OrderId — (String)

        The phone number's order ID.

      • Name — (String)

        The name of the phone number.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ID of the phone number order .

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberOrder — (map)

      The phone number order details.

      • PhoneNumberOrderId — (String)

        The ID of the phone order.

      • ProductType — (String)

        The phone number order product type.

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

        The status of the phone number order.

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

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

        Possible values include:
        • "New"
        • "Porting"
      • OrderedPhoneNumbers — (Array<map>)

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

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Status — (String)

          The phone number status.

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

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

      • UpdatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • CallingName — (String)

      The default outbound calling name for the account.

    • CallingNameUpdatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

  • ProxySessionId — (String)

    The proxy session ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProxySession — (map)

      The proxy session details.

      • VoiceConnectorId — (String)

        The Voice Connector ID.

      • ProxySessionId — (String)

        The proxy session ID.

      • Name — (String)

        The proxy session name.

      • Status — (String)

        The proxy session status.

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

        The number of minutes allowed for the proxy session.

      • Capabilities — (Array<String>)

        The proxy session capabilities.

      • CreatedTimestamp — (Date)

        The created time stamp, in ISO 8601 format.

      • UpdatedTimestamp — (Date)

        The updated time stamp, in ISO 8601 format.

      • EndedTimestamp — (Date)

        The ended time stamp, in ISO 8601 format.

      • Participants — (Array<map>)

        The proxy session participants.

        • PhoneNumber — (String)

          The participant's phone number.

        • ProxyPhoneNumber — (String)

          The participant's proxy phone number.

      • NumberSelectionBehavior — (String)

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

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

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

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

        The country and area code for the proxy phone number.

        • Country — required — (String)

          The country.

        • AreaCode — required — (String)

          The area code.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The SIP media application ID .

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplication — (map)

      The details of the SIP media application.

      • SipMediaApplicationId — (String)

        A SIP media application's ID.

      • AwsRegion — (String)

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

      • Name — (String)

        The SIP media application's name.

      • Endpoints — (Array<map>)

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

        • LambdaArn — (String)

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

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

        The time at which the SIP media application was updated.

      • SipMediaApplicationArn — (String)

        The ARN of the SIP media application.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The SIP media application ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplicationAlexaSkillConfiguration — (map)

      Returns the Alexa Skill configuration.

      • AlexaSkillStatus — required — (String)

        The status of the Alexa Skill configuration.

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

        The ID of the Alexa Skill configuration.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The SIP media application ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplicationLoggingConfiguration — (map)

      The actual logging configuration.

      • EnableSipMediaApplicationMessageLogs — (Boolean)

        Enables message logging for the specified SIP media application.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The SIP rule ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipRule — (map)

      The SIP rule details.

      • SipRuleId — (String)

        A SIP rule's ID.

      • Name — (String)

        A SIP rule's name.

      • Disabled — (Boolean)

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

      • TriggerType — (String)

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

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

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

      • TargetApplications — (Array<map>)

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

        • SipMediaApplicationId — (String)

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

        • Priority — (Integer)

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

        • AwsRegion — (String)

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

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

  • SpeakerSearchTaskId — (String)

    The ID of the speaker search task.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SpeakerSearchTask — (map)

      The details of the speaker search task.

      • SpeakerSearchTaskId — (String)

        The speaker search task ID.

      • SpeakerSearchTaskStatus — (String)

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

      • CallDetails — (map)

        The call details of a speaker search task.

        • VoiceConnectorId — (String)

          The Voice Connector ID.

        • TransactionId — (String)

          The transaction ID of a Voice Connector call.

        • IsCaller — (Boolean)

          Identifies a person as the caller or the callee.

      • SpeakerSearchDetails — (map)

        The details of a speaker search task.

        • Results — (Array<map>)

          The result value in the speaker search details.

          • ConfidenceScore — (Float)

            The confidence score in the speaker search analysis.

          • VoiceProfileId — (String)

            The voice profile ID.

        • VoiceprintGenerationStatus — (String)

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

      • CreatedTimestamp — (Date)

        The time at which a speaker search task was created.

      • UpdatedTimestamp — (Date)

        The time at which a speaker search task was updated.

      • StartedTimestamp — (Date)

        The time at which the speaker search task began.

      • StatusMessage — (String)

        A detailed message about the status of a speaker search.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnector — (map)

      The Voice Connector details.

      • VoiceConnectorId — (String)

        The Voice Connector's ID.

      • AwsRegion — (String)

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

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

        The Voice Connector's name.

      • OutboundHostName — (String)

        The outbound host name for the Voice Connector.

      • RequireEncryption — (Boolean)

        Enables or disables encryption for the Voice Connector.

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

      • VoiceConnectorArn — (String)

        The ARN of the Voice Connector.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • EmergencyCallingConfiguration — (map)

      The details of the emergency calling configuration.

      • DNIS — (Array<map>)

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

        • EmergencyPhoneNumber — required — (String)

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

        • TestPhoneNumber — (String)

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

        • CallingCountry — required — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector group ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectorGroup — (map)

      The details of the Voice Connector group.

      • VoiceConnectorGroupId — (String)

        The ID of a Voice Connector group.

      • Name — (String)

        The name of a Voice Connector group.

      • VoiceConnectorItems — (Array<map>)

        The Voice Connectors to which you route inbound calls.

        • VoiceConnectorId — required — (String)

          The Voice Connector ID.

        • Priority — required — (Integer)

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

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

      • VoiceConnectorGroupArn — (String)

        The ARN of the Voice Connector group.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • LoggingConfiguration — (map)

      The logging configuration details .

      • EnableSIPLogs — (Boolean)

        Boolean that enables sending SIP message logs to Amazon CloudWatch.

      • EnableMediaMetricLogs — (Boolean)

        Enables or disables media metrics logging.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Origination — (map)

      The origination setting details.

      • Routes — (Array<map>)

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

        • Host — (String)

          The FQDN or IP address to contact for origination traffic.

        • Port — (Integer)

          The designated origination route port. Defaults to 5060.

        • Protocol — (String)

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

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

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

        • Weight — (Integer)

          The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

      • Disabled — (Boolean)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Proxy — (map)

      The proxy configuration details.

      • DefaultSessionExpiryMinutes — (Integer)

        The default number of minutes allowed for proxy sessions.

      • Disabled — (Boolean)

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

      • FallBackPhoneNumber — (String)

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

      • PhoneNumberCountries — (Array<String>)

        The countries for proxy phone numbers to be selected from.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • StreamingConfiguration — (map)

      The details of the streaming configuration.

      • DataRetentionInHours — required — (Integer)

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

      • Disabled — required — (Boolean)

        When true, streaming to Kinesis is off.

      • StreamingNotificationTargets — (Array<map>)

        The streaming notification targets.

        • NotificationTarget — (String)

          The streaming notification target.

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

        The call analytics configuration.

        • Disabled — (Boolean)

          Denotes the configration as enabled or disabled.

        • ConfigurationArn — (String)

          The configuration's ARN.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Termination — (map)

      The termination setting details.

      • CpsLimit — (Integer)

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

      • DefaultPhoneNumber — (String)

        The default outbound calling number.

      • CallingRegions — (Array<String>)

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

      • CidrAllowedList — (Array<String>)

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

      • Disabled — (Boolean)

        When termination is disabled, outbound calls cannot be made.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Voice Connector ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • TerminationHealth — (map)

      The termination health details.

      • Timestamp — (Date)

        The timestamp, in ISO 8601 format.

      • Source — (String)

        The source IP address.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The voice profile ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceProfile — (map)

      The voice profile details.

      • VoiceProfileId — (String)

        The ID of the voice profile.

      • VoiceProfileArn — (String)

        The ARN of the voice profile.

      • VoiceProfileDomainId — (String)

        The ID of the domain that contains the voice profile.

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

        The time at which the voice profile was last updated.

      • ExpirationTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The voice profile domain ID.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceProfileDomain — (map)

      The details of the voice profile domain.

      • VoiceProfileDomainId — (String)

        The ID of the voice profile domain.

      • VoiceProfileDomainArn — (String)

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

      • Name — (String)

        The name of the voice profile domain.

      • Description — (String)

        The description of the voice profile domain.

      • ServerSideEncryptionConfiguration — (map)

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

        • KmsKeyArn — required — (String)

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

      • CreatedTimestamp — (Date)

        The time at which the voice profile domain was created.

      • UpdatedTimestamp — (Date)

        The time at which the voice profile was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  IsCaller: true || false, /* required */
  VoiceConnectorId: 'STRING_VALUE', /* required */
  VoiceToneAnalysisTaskId: 'STRING_VALUE' /* required */
};
chimesdkvoice.getVoiceToneAnalysisTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Voice Connector ID.

  • VoiceToneAnalysisTaskId — (String)

    The ID of the voice tone anlysis task.

  • IsCaller — (Boolean)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceToneAnalysisTask — (map)

      The details of the voice tone analysis task.

      • VoiceToneAnalysisTaskId — (String)

        The ID of the voice tone analysis task.

      • VoiceToneAnalysisTaskStatus — (String)

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

      • CallDetails — (map)

        The call details of a voice tone analysis task.

        • VoiceConnectorId — (String)

          The Voice Connector ID.

        • TransactionId — (String)

          The transaction ID of a Voice Connector call.

        • IsCaller — (Boolean)

          Identifies a person as the caller or the callee.

      • CreatedTimestamp — (Date)

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

      • UpdatedTimestamp — (Date)

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

      • StartedTimestamp — (Date)

        The time at which a voice tone analysis task started.

      • StatusMessage — (String)

        The status of a voice tone analysis task.

Returns:

• (AWS.Request) —

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