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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)
      • PhoneNumberId — (String)
      • ErrorCode — (String) Possible values include:
        • "BadRequest"
        • "Conflict"
        • "Forbidden"
        • "NotFound"
        • "PreconditionFailed"
        • "ResourceLimitExceeded"
        • "ServiceFailure"
        • "AccessDenied"
        • "ServiceUnavailable"
        • "Throttled"
        • "Throttling"
        • "Unauthorized"
        • "Unprocessable"
        • "VoiceConnectorGroupAssociationsExist"
        • "PhoneNumberAssociationsExist"
        • "Gone"
      • ErrorMessage — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)
      • PhoneNumberId — (String)
      • ErrorCode — (String) Possible values include:
        • "BadRequest"
        • "Conflict"
        • "Forbidden"
        • "NotFound"
        • "PreconditionFailed"
        • "ResourceLimitExceeded"
        • "ServiceFailure"
        • "AccessDenied"
        • "ServiceUnavailable"
        • "Throttled"
        • "Throttling"
        • "Unauthorized"
        • "Unprocessable"
        • "VoiceConnectorGroupAssociationsExist"
        • "PhoneNumberAssociationsExist"
        • "Gone"
      • ErrorMessage — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • UpdatePhoneNumberRequestItems — (Array<map>)
    • PhoneNumberId — required — (String)
    • ProductType — (String) Possible values include:
      • "VoiceConnector"
      • "SipMediaApplicationDialIn"
    • CallingName — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)
      • PhoneNumberId — (String)
      • ErrorCode — (String) Possible values include:
        • "BadRequest"
        • "Conflict"
        • "Forbidden"
        • "NotFound"
        • "PreconditionFailed"
        • "ResourceLimitExceeded"
        • "ServiceFailure"
        • "AccessDenied"
        • "ServiceUnavailable"
        • "Throttled"
        • "Throttling"
        • "Unauthorized"
        • "Unprocessable"
        • "VoiceConnectorGroupAssociationsExist"
        • "PhoneNumberAssociationsExist"
        • "Gone"
      • ErrorMessage — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • ProductType — (String) Possible values include:
    • "VoiceConnector"
    • "SipMediaApplicationDialIn"
  • E164PhoneNumbers — (Array<String>)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • VoiceConnectorId — (String)
  • ParticipantPhoneNumbers — (Array<String>)
  • Name — (String)
  • ExpiryMinutes — (Integer)
  • Capabilities — (Array<String>)
  • NumberSelectionBehavior — (String) Possible values include:
    • "PreferSticky"
    • "AvoidSticky"
  • GeoMatchLevel — (String) Possible values include:
    • "Country"
    • "AreaCode"
  • GeoMatchParams — (map)
    • Country — required — (String)
    • AreaCode — required — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProxySession — (map)
      • VoiceConnectorId — (String)
      • ProxySessionId — (String)
      • Name — (String)
      • Status — (String) Possible values include:
        • "Open"
        • "InProgress"
        • "Closed"
      • ExpiryMinutes — (Integer)
      • Capabilities — (Array<String>)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • EndedTimestamp — (Date)
      • Participants — (Array<map>)
        • PhoneNumber — (String)
        • ProxyPhoneNumber — (String)
      • NumberSelectionBehavior — (String) Possible values include:
        • "PreferSticky"
        • "AvoidSticky"
      • GeoMatchLevel — (String) Possible values include:
        • "Country"
        • "AreaCode"
      • GeoMatchParams — (map)
        • Country — required — (String)
        • AreaCode — required — (String)

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 */
};
chimesdkvoice.createSipMediaApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AwsRegion — (String)
  • Name — (String)
  • Endpoints — (Array<map>)
    • LambdaArn — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplication — (map)
      • SipMediaApplicationId — (String)
      • AwsRegion — (String)
      • Name — (String)
      • Endpoints — (Array<map>)
        • LambdaArn — (String)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • FromPhoneNumber — (String)
  • ToPhoneNumber — (String)
  • SipMediaApplicationId — (String)
  • SipHeaders — (map<String>)
  • ArgumentsMap — (map<String>)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplicationCall — (map)
      • TransactionId — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)
  • TriggerType — (String) Possible values include:
    • "ToPhoneNumber"
    • "RequestUriHostname"
  • TriggerValue — (String)
  • Disabled — (Boolean)
  • TargetApplications — (Array<map>)
    • SipMediaApplicationId — (String)
    • Priority — (Integer)
    • AwsRegion — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)
  • AwsRegion — (String) Possible values include:
    • "us-east-1"
    • "us-west-2"
    • "ca-central-1"
    • "eu-central-1"
    • "eu-west-1"
    • "eu-west-2"
    • "ap-northeast-2"
    • "ap-northeast-1"
    • "ap-southeast-1"
    • "ap-southeast-2"
  • RequireEncryption — (Boolean)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnector — (map)
      • VoiceConnectorId — (String)
      • AwsRegion — (String) Possible values include:
        • "us-east-1"
        • "us-west-2"
        • "ca-central-1"
        • "eu-central-1"
        • "eu-west-1"
        • "eu-west-2"
        • "ap-northeast-2"
        • "ap-northeast-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
      • Name — (String)
      • OutboundHostName — (String)
      • RequireEncryption — (Boolean)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • VoiceConnectorArn — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)
  • VoiceConnectorItems — (Array<map>)
    • VoiceConnectorId — required — (String)
    • Priority — required — (Integer)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectorGroup — (map)
      • VoiceConnectorGroupId — (String)
      • Name — (String)
      • VoiceConnectorItems — (Array<map>)
        • VoiceConnectorId — required — (String)
        • Priority — required — (Integer)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • VoiceConnectorGroupArn — (String)

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)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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)
  • ProxySessionId — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)
      • PhoneNumberId — (String)
      • ErrorCode — (String) Possible values include:
        • "BadRequest"
        • "Conflict"
        • "Forbidden"
        • "NotFound"
        • "PreconditionFailed"
        • "ResourceLimitExceeded"
        • "ServiceFailure"
        • "AccessDenied"
        • "ServiceUnavailable"
        • "Throttled"
        • "Throttling"
        • "Unauthorized"
        • "Unprocessable"
        • "VoiceConnectorGroupAssociationsExist"
        • "PhoneNumberAssociationsExist"
        • "Gone"
      • ErrorMessage — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberErrors — (Array<map>)
      • PhoneNumberId — (String)
      • ErrorCode — (String) Possible values include:
        • "BadRequest"
        • "Conflict"
        • "Forbidden"
        • "NotFound"
        • "PreconditionFailed"
        • "ResourceLimitExceeded"
        • "ServiceFailure"
        • "AccessDenied"
        • "ServiceUnavailable"
        • "Throttled"
        • "Throttling"
        • "Unauthorized"
        • "Unprocessable"
        • "VoiceConnectorGroupAssociationsExist"
        • "PhoneNumberAssociationsExist"
        • "Gone"
      • ErrorMessage — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnector — (map)
      • CdrBucket — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • CallingName — (String)
    • CallingNameUpdatedTimestamp — (Date)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProxySession — (map)
      • VoiceConnectorId — (String)
      • ProxySessionId — (String)
      • Name — (String)
      • Status — (String) Possible values include:
        • "Open"
        • "InProgress"
        • "Closed"
      • ExpiryMinutes — (Integer)
      • Capabilities — (Array<String>)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • EndedTimestamp — (Date)
      • Participants — (Array<map>)
        • PhoneNumber — (String)
        • ProxyPhoneNumber — (String)
      • NumberSelectionBehavior — (String) Possible values include:
        • "PreferSticky"
        • "AvoidSticky"
      • GeoMatchLevel — (String) Possible values include:
        • "Country"
        • "AreaCode"
      • GeoMatchParams — (map)
        • Country — required — (String)
        • AreaCode — required — (String)

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)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplication — (map)
      • SipMediaApplicationId — (String)
      • AwsRegion — (String)
      • Name — (String)
      • Endpoints — (Array<map>)
        • LambdaArn — (String)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

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)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplicationLoggingConfiguration — (map)
      • EnableSipMediaApplicationMessageLogs — (Boolean)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnector — (map)
      • VoiceConnectorId — (String)
      • AwsRegion — (String) Possible values include:
        • "us-east-1"
        • "us-west-2"
        • "ca-central-1"
        • "eu-central-1"
        • "eu-west-1"
        • "eu-west-2"
        • "ap-northeast-2"
        • "ap-northeast-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
      • Name — (String)
      • OutboundHostName — (String)
      • RequireEncryption — (Boolean)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • VoiceConnectorArn — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • EmergencyCallingConfiguration — (map)
      • DNIS — (Array<map>)
        • EmergencyPhoneNumber — required — (String)
        • TestPhoneNumber — (String)
        • CallingCountry — required — (String)

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)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectorGroup — (map)
      • VoiceConnectorGroupId — (String)
      • Name — (String)
      • VoiceConnectorItems — (Array<map>)
        • VoiceConnectorId — required — (String)
        • Priority — required — (Integer)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • VoiceConnectorGroupArn — (String)

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)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • LoggingConfiguration — (map)
      • EnableSIPLogs — (Boolean)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Proxy — (map)
      • DefaultSessionExpiryMinutes — (Integer)
      • Disabled — (Boolean)
      • FallBackPhoneNumber — (String)
      • PhoneNumberCountries — (Array<String>)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • StreamingConfiguration — (map)
      • DataRetentionInHours — required — (Integer)
      • Disabled — required — (Boolean)
      • StreamingNotificationTargets — (Array<map>)
        • NotificationTarget — (String) Possible values include:
          • "EventBridge"
          • "SNS"
          • "SQS"

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Termination — (map)
      • CpsLimit — (Integer)
      • DefaultPhoneNumber — (String)
      • CallingRegions — (Array<String>)
      • CidrAllowedList — (Array<String>)
      • Disabled — (Boolean)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • TerminationHealth — (map)
      • Timestamp — (Date)
      • Source — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectorRegions — (Array<String>)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

var params = {
  FilterName: VoiceConnectorId | VoiceConnectorGroupId | SipRuleId,
  FilterValue: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProductType: VoiceConnector | SipMediaApplicationDialIn,
  Status: 'STRING_VALUE'
};
chimesdkvoice.listPhoneNumbers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Status — (String)
  • ProductType — (String) Possible values include:
    • "VoiceConnector"
    • "SipMediaApplicationDialIn"
  • FilterName — (String) Possible values include:
    • "VoiceConnectorId"
    • "VoiceConnectorGroupId"
    • "SipRuleId"
  • FilterValue — (String)
  • MaxResults — (Integer)
  • NextToken — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: Open | InProgress | Closed
};
chimesdkvoice.listProxySessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VoiceConnectorId — (String)
  • Status — (String) Possible values include:
    • "Open"
    • "InProgress"
    • "Closed"
  • NextToken — (String)
  • MaxResults — (Integer)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProxySessions — (Array<map>)
      • VoiceConnectorId — (String)
      • ProxySessionId — (String)
      • Name — (String)
      • Status — (String) Possible values include:
        • "Open"
        • "InProgress"
        • "Closed"
      • ExpiryMinutes — (Integer)
      • Capabilities — (Array<String>)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • EndedTimestamp — (Date)
      • Participants — (Array<map>)
        • PhoneNumber — (String)
        • ProxyPhoneNumber — (String)
      • NumberSelectionBehavior — (String) Possible values include:
        • "PreferSticky"
        • "AvoidSticky"
      • GeoMatchLevel — (String) Possible values include:
        • "Country"
        • "AreaCode"
      • GeoMatchParams — (map)
        • Country — required — (String)
        • AreaCode — required — (String)
    • NextToken — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplications — (Array<map>)
      • SipMediaApplicationId — (String)
      • AwsRegion — (String)
      • Name — (String)
      • Endpoints — (Array<map>)
        • LambdaArn — (String)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
    • NextToken — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

var params = {
  ProductType: VoiceConnector | SipMediaApplicationDialIn /* required */
};
chimesdkvoice.listSupportedPhoneNumberCountries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProductType — (String) Possible values include:
    • "VoiceConnector"
    • "SipMediaApplicationDialIn"

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PhoneNumberCountries — (Array<map>)
      • CountryCode — (String)
      • SupportedPhoneNumberTypes — (Array<String>)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectorGroups — (Array<map>)
      • VoiceConnectorGroupId — (String)
      • Name — (String)
      • VoiceConnectorItems — (Array<map>)
        • VoiceConnectorId — required — (String)
        • Priority — required — (Integer)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • VoiceConnectorGroupArn — (String)
    • NextToken — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • VoiceConnectors — (Array<map>)
      • VoiceConnectorId — (String)
      • AwsRegion — (String) Possible values include:
        • "us-east-1"
        • "us-west-2"
        • "ca-central-1"
        • "eu-central-1"
        • "eu-west-1"
        • "eu-west-2"
        • "ap-northeast-2"
        • "ap-northeast-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
      • Name — (String)
      • OutboundHostName — (String)
      • RequireEncryption — (Boolean)
      • CreatedTimestamp — (Date)
      • UpdatedTimestamp — (Date)
      • VoiceConnectorArn — (String)
    • NextToken — (String)

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Usernames — (Array<String>)

Returns:

• (AWS.Request) —

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

var params = {
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  SipMediaApplicationAlexaSkillConfiguration: {
    AlexaSkillIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    AlexaSkillStatus: ACTIVE | INACTIVE /* required */
  }
};
chimesdkvoice.putSipMediaApplicationAlexaSkillConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SipMediaApplicationId — (String)
  • SipMediaApplicationAlexaSkillConfiguration — (map)
    • AlexaSkillStatus — required — (String) Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • AlexaSkillIds — required — (Array<String>)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • SipMediaApplicationId — (String)
  • SipMediaApplicationLoggingConfiguration — (map)
    • EnableSipMediaApplicationMessageLogs — (Boolean)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SipMediaApplicationLoggingConfiguration — (map)
      • EnableSipMediaApplicationMessageLogs — (Boolean)

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • VoiceConnectorId — (String)
  • EmergencyCallingConfiguration — (map)
    • DNIS — (Array<map>)
      • EmergencyPhoneNumber — required — (String)
      • TestPhoneNumber — (String)
      • CallingCountry — required — (String)

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • EmergencyCallingConfiguration — (map)
      • DNIS — (Array<map>)
        • EmergencyPhoneNumber — required — (String)
        • TestPhoneNumber — (String)
        • CallingCountry — required — (String)