Private Branch Exchange API Reference for Alexa Smart Properties

Note: Sign in to the developer console to build or publish your skill.

Note: This feature is currently available only in the US.

Use the Private Branch Exchange (PBX) API to integrate your Session Initiation Protocol (SIP)-based PBX system with Alexa. You can use the PBX API to manage SIP trunk connectivity between your Alexa Smart Properties units, such as rooms, and extensions on your PBX.

For steps to configure your PBX system to work with Alexa-enabled devices in rooms on a property that has an Alexa Smart Properties subscription, see Configure a Private Branch Exchange for Alexa Smart Properties. For details about PBX systems, see Private branch exchange.

API endpoint

The endpoint of the PBX API is https://api.amazonalexa.com/v1/communications/network/siptrunk.

Authentication

Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA).

Operations

The PBX API supports the following types of operations:

SIP trunk management
Extension management

SIP trunk management

Operation	HTTP method and URI
Create a SIP trunk	`POST /v1/communications/network/siptrunk`
Get a SIP trunk	`GET /v1/communications/network/siptrunk/{trunkId}`
List all SIP trunks	`GET /v1/communications/network/siptrunk`
Update a SIP trunk	`PUT /v1/communications/network/siptrunk/{trunkId}`
Delete a SIP trunk	`DELETE /v1/communications/network/siptrunk/{trunkId}`

Extension management

Operation	HTTP method and URI
Map an extension	`POST /v1/communications/network/siptrunk/{trunkId}/extension/{extension}`
Get an extension mapping	`GET /v1/communications/network/siptrunk/{trunkId}/extension/{extension}`
Update an extension mapping	`PUT /v1/communications/network/siptrunk/{trunkId}/extension/{extension}`
Delete an extension mapping	`DELETE /v1/communications/network/siptrunk/{trunkId}/extension/{extension}`
List extensions in batch	`GET /v1/communications/network/siptrunk/{trunkId}/extensions`

Create a SIP trunk

Create trunk connectivity between Alexa and your PBX. You can specify Internet Protocol (IP)-based peers or Fully Qualified Domain Name (FQDN)-based peers.

If you use IP-based peers, the request URI for calls that initiate from Alexa-enabled devices use IPs as the SIP domain. If you use FQDN peers, the request URI for calls that initiate from Alexa-enabled devices use FQDNs as the SIP domain. You can use either IP-based peers or FQDN-based peers, but not both at the same time.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To create a SIP trunk, make a POST request to /v1/communications/network/siptrunk.

Request path and header example

Copied to clipboard.

POST /v1/communications/network/siptrunk HTTP/1.1
Host: api.amazonalexa.com
Content-type: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

Request body properties

Property	Description	Type	Required
`tls`	Information about your Transport Layer Security (TLS) configuration.	Object	Yes if your system uses TLS for transport.
`tls.certificateChain[]`	List of Privacy Enhanced Mail (PEM)-encoded certificate chains. The certificate chains should contain the standard PEM header and footer. Each item might contain multiple certificates, and therefore form a chain for the certificate. You can define multiple certificates to support certificate rotation.	Array of strings	Yes if your system uses TLS for transport.
`tls.name`	Common Name (CN) or Subject Alternative Name (SAN) of the certificate. You don't need to align this name with the `peerAddress` parameter. This parameter is used for certificate validation purpose only.	String	Yes if your system uses TLS for transport.
`peers[]`	IP-based peer configuration. Use `peers` for IP-based configurations. Use `peer` for FQDN-based configurations.	Array of objects	Either `peers` or `peer`.
`peers[].ip`	IP address of the peer. You can define multiple addresses for high availability. Either `peers` or `peer` should be present, not both. Mixed configurations aren't supported.	String	Yes for IP-based configurations
`peers[].port`	Port number to use to connect to the peer.	Number	Yes for IP-based configurations
`peer`	FQDN-based peer configuration. Use `peers` for IP-based configurations. Use `peer` for FQDN-based configurations.	Object	Either `peers` or `peer`.
`peer.name`	Domain Name System (DNS) record for the peer. If defined, the system attempts routing by using Service Locator (SRV) records. Either `peers` or `peer` should be present, not both. Mixed configurations aren't supported.	String	Yes for FQDN-based configurations
`peer.port`	Port number to use to connect to the peer.	Number	Yes for FQDN-based configurations

Response

A successful response returns HTTP 201 Created, along with the status of the target. On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message. For details, see HTTP status codes.

Response body example

HTTP/1.1 201 Created
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json
{
  "trunkId": "amzn1.alexa.network.siptrunk.59216beb",
  "status": "PROVISIONING",
  "endpoint": "59216beb.siptrunk.prod.amcs-tachyon.com",
  "operationId": "dfwqewqre342342"
}

Response body properties

Property	Description	Type
`trunkId`	Unique identifier of the created SIP trunk.	String
`status`	Request status. Possible value: `PROVISIONING`, which means that the trunk is in the process of creation or modification. Users might not be able to make phone calls during this stage.	Enum
`endpoint`	DNS name or IP address of the endpoint that should be entered to the user's PBX system. Depending on the underlying signaling implementation, this value might not be present during `PROVISIONING` state.	String
`operationId`	Unique identifier that you use to reference the operation status.	String

Tip: You can create multiple SIP trunks as long as their peering IPs don't overlap.

Note: If your SIP trunk creation fails after changing status to PROVISIONING, reach out to your Alexa Smart Properties solution architect with your trunk details.

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.
`503 Service Unavailable`	The server is temporarily unavailable.

Get a SIP trunk

To verify whether your trunk creation is successful, make a GET SIP trunk request. The successful response should have the status as ACTIVE. After you start a Create a SIP trunk operation, it takes five to ten minutes for a SIP trunk to be active.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US
US

Request

To get the status of a specific SIP trunk, make a GET request to /v1/communications/network/siptrunk/{trunkId}.

Request path and header example

Copied to clipboard.

GET /v1/communications/network/siptrunk/amzn1.alexa.network.siptrunk.1234abc HTTP/1.1
Host: api.amazonalexa.com
Content-type: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`{trunkId}`	Path	SIP trunk ID.	String	Yes
`{access token}`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

A successful response returns HTTP 200 OK, along with the status of the target. On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message. For details, see HTTP status codes.

Response body example

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json
{
  "trunkId": "59216beb",
  "status": "ACTIVE",
  "endpoint": "59216beb.siptrunk.prod.amcs-tachyon.com",
  "configuration": {
    "tls": {
      "certificateChain": [
        "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
        "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
      ],
      "name": "pbx.example.com"
    },
    "peer": {
      "ip": ["11.22.33.44"],
      "port": 5061
    }
  }
}

Response body properties

Property	Description	Type
`trunkId`	Unique identifier of the created SIP trunk.	String
`status`	Description of the request status. Possible values: • `PROVISIONING`: The trunk is in the process of creation or modification. Users might not be able to make phone calls during this stage. • `ACTIVE`: The trunk is fully configured and operational. • `UPDATING`: The trunk is still operational and a new configuration is being updated to the trunk. • `DELETE`: The trunk is disabled and associated resources are deprovisioned.	Enum
`endpoint`	DNS name or IP address of the endpoint that should be entered to the user's PBX system. Depending on the underlying signaling implementation, this value might not be present during `PROVISIONING` state.	String
`configuration`	Information about the SIP trunk parameters.	Object
`configuration.tls`	Information about the TLS configuration.	Object
`configuration.tls.certificationChain[]`	List of Privacy Enhanced Mail (PEM)-encoded certificate chains.	Array of objects
`configuration.tls.name`	CN or SAN of the certificate.	String
`peer`	Information about the peer connection.	Object
`peer.ip[]`	IPs of the peer connection.	Array of strings
`peer.port`	Port number that is used to connect to the peer.	Number

Note: If your trunk status is still PROVISIONING after ten minutes, contact your Alexa Smart Properties solution architect with your SIP trunk details.

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` isn't found.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

List all SIP trunks

List all SIP trunks that are associated with this account.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To get a full list of all the SIP trunks and their statuses, make a GET request to /v1/communications/network/siptrunk.

Request path and header example

Copied to clipboard.

GET /v1/communications/network/siptrunk?nextToken=0&maxResults=10 HTTP/1.1
Host: api.amazonalexa.com
Content-type: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`nextToken`	Query	Token to provide when you request the next page for the previous result. When you don't provide this token, the operation assumes that this is the first request.	String	No
`maxResults`	Query	Maximum number of items to return. When you don't provide this value, the default is 30.	Number	No
`{access token}`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

Response body example

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json
{
  "paginationContext": {
    "totalCount": 30,
    "nextPageToken": "0"
  },
  "trunks": [
    {
      "trunkId": "amzn1.alexa.network.siptrunk.59216beb",
      "endpoint": "59216beb.pbx.amcs-tachyon.com",
      "status": "ACTIVE"
    }, {
      "trunkId": "amzn1.alexa.network.siptrunk.76351f6a",
      "endpoint": "76351f6a.pbx.amcs-tachyon.com",
      "status": "ACTIVE"
    }
  ]
}

Response body properties

Property	Description	Type
`paginationContext`	Information about pagination.	Object
`paginationContext.totalCount`	Total number of trunks associated with the account.	Number
`paginationContext.nextPageToken`	Starting pointer of the current query.	String
`trunks[]`	Details about the trunks.	Array of objects
`trunks[].trunkId`	Trunk ID for the given item.	String
`trunks[].endpoint`	Endpoint DNS name that the user should connect to.	String
`trunks[].status`	Status of the trunk. Possible values: • `PROVISIONING`: The trunk is in the process of creation or modification. Users might not be able to make phone calls during this stage. • `ACTIVE`: The trunk is fully configured and operational. • `UPDATING`: The trunk is still operational and a new configuration is being updated to the trunk. • `DELETE`: The trunk is disabled and associated resources are deprovisioned.	Enum

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

Update a SIP trunk

Update an active SIP trunk information.

Note: You can only update trunks that are in the ACTIVE state.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To update a SIP trunk, make a PUT request to /v1/communications/network/siptrunk/{trunkId}.

Request path and header example

Copied to clipboard.

PUT /v1/communications/network/siptrunk/amzn1.alexa.network.siptrunk.59216beb HTTP/1.1
Host: api.amazonalexa.com
Content-type: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	Unique identifier of the trunk. Format: `amzn1.alexa.network.siptrunk.{ID}`.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

Request body properties

Property	Description	Type	Required
`tls`	Information about your TLS configuration.	Object	Yes if your system uses TLS for transport.
`tls.certificateChain[]`	List of Privacy Enhanced Mail (PEM)-encoded certificate chains. The certificate chains should contain the standard PEM header and footer. Each item might contain multiple certificates, and therefore form a chain for the certificate. You can define multiple certificates to support certificate rotation.	Array of strings	Yes if your system uses TLS for transport.
`tls.name`	CN or SAN name of the certificate.	String	Yes if your system uses TLS for transport.
`peers[]`	IP-based peer configuration. Use `peers` for IP-based configurations. Use `peer` for FQDN-based configurations.	Array of objects	Either `peers` or `peer`.
`peers[].ip`	IP address of the peer. You can define multiple addresses for high availability. Either `peers` or `peer` should be present, not both. Mixed configurations aren't supported.	String	Yes for IP-based configurations
`peers[].port`	Port number to use to connect to the peer.	Number	Yes for IP-based configurations
`peer`	FQDN-based peer configuration. Use `peers` for IP-based configurations. Use `peer` for FQDN-based configurations.	Object	Either `peers` or `peer`.
`peer.name`	DNS record for the peer. If defined, Service Locator (SRV) record-based routing is attempted. Either `peers` or `peer` should be present, not both. Mixed configurations aren't supported.	String	Yes for FQDN-based configurations
`peer.port`	Port number to use to connect to the peer.	Number	Yes for FQDN-based configurations

Response

Response body example

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json
{
  "trunkId": "amzn1.alexa.network.siptrunk.59216beb",
  "status": "UPDATING",
  "operationId": "dfwqewqre342342"
}

Response body properties

Property	Description	Type
`trunkId`	Unique identifier of the created SIP trunk.	String
`status`	Status of the trunk after receiving the updated parameters. Possible values: `PROVISIONING`, `ACTIVE`, `UPDATING`, `DELETING`.	Enum
`operationId`	Unique identifier that you use to reference the operation status.	String

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` isn't found.
`409 Conflict`	There's a conflict with the existing `trunkId`.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.
`503 Service Unavailable`	The server is temporarily unavailable.

Delete a SIP trunk

Delete a SIP trunk.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To delete a SIP trunk, make a DELETE request to /v1/communications/network/siptrunk/{trunkId}.

Request path and header example

Copied to clipboard.

DELETE /v1/communications/network/siptrunk/amzn1.alexa.network.siptrunk.59216beb HTTP/1.1
Host: api.amazonalexa.com
Content-type: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	Unique identifier of the trunk for deletion. Format: `amzn1.alexa.network.siptrunk.{ID}`.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

Response body example

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json
{
  "trunkId": "amzn1.alexa.network.siptrunk.59216beb",
  "status": "DELETING",
  "operationId": "dfwqewqre342342"
}

Response body properties

Property	Description	Type
`trunkId`	Unique identifier of the created SIP trunk.	String
`status`	Status of the trunk after receiving the delete operation. Possible value: `DELETING`, which indicates that the trunk is in the process to be deleted.	Enum
`operationId`	Unique identifier that you use to reference the operation status.	String

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` isn't found.
`409 Conflict`	There's a conflict with the existing `trunkId`.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.
`503 Service Unavailable`	The server is temporarily unavailable.

Map an extension

Map an Alexa device in a room in your property to an extension on your PBX. If the mapping already exists, this operation updates the mapping.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To map an extension with a unit, such as a room, make a POST request to /v1/communications/network/siptrunk/{trunkId}/extension/{extension}.

Request path and header example

Copied to clipboard.

POST /v1/communications/network/siptrunk/amzn1.comms.network.siptrunk.59216beb/extension/7201 HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	Trunk ID for the extension mapping.	String	Yes
`extension`	Path	Internal extension number for the unit. Typically this string is a few digits of number, but might include alphanumeric characters.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

Request body properties

Property	Description	Type	Required
`routingType`	Routing type. Possible value: `communication-profile`.	Enum	Yes
`commsProfileId`	Profile ID to attach the mapping. For Alexa Smart Properties, the format is `amzn1.alexa.unit.did.{ID}`. For details about communication profile IDs, see Manage communication profiles.	String	Yes

Response

A successful creation response returns HTTP 200 OK. On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message. For details, see HTTP status codes.

Response body example

The successful response has no body.

Response body properties

The successful response has no body.

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` or `extension` isn't found.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

Get an extension mapping

Retrieve the mapping between the Alexa device in a room in your property and an extension on your PBX.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To retrieve the extension mapping between a unit and an extension on your PBX, make a GET request to /v1/communications/network/siptrunk/{trunkId}/extension/{extension}.

Request path and header example

Copied to clipboard.

GET /v1/communications/network/siptrunk/amzn1.comms.network.siptrunk.59216beb/extension/7201 HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	Trunk ID for the extension mapping.	String	Yes
`extension`	Path	Internal extension number for the unit. Typically, this string is a few digits of a number, but might include alphanumeric characters.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

Response body example

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json

{
  "routingType": "communication-profile",
  "commsProfileId": "amzn1.alexa.unit.did.abcdef1234"
}

Response body properties

Property	Description	Type
`routingType`	Routing type. Possible value: `communication-profile`.	Enum
`commsProfileId`	Profile ID to attach the mapping. For Alexa Smart Properties, the format is `amzn1.alexa.unit.did.{ID}`. For details about communication profile IDs, see Manage communication profiles.	String

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` or `extension` isn't found.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

Update an extension mapping

You can update an Alexa device mapping in a room in your property with a new profile on your PBX.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To update an extension with a different profile, make a PUT request to /v1/communications/network/siptrunk/{trunkId}/extension/{extension}.

Request path and header example

Copied to clipboard.

PUT /v1/communications/network/siptrunk/amzn1.comms.network.siptrunk.59216beb/extension/7201 HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	A trunk ID for the extension mapping.	String	Yes
`extension`	Path	Internal extension number for the unit. Typically, this string is a few digits of a number, but might include alphanumeric characters.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

Request body properties

Property	Description	Type	Required
`routingType`	Routing type. Possible value: `communication-profile`.	Enum	Yes
`commsProfileId`	Profile ID to attach the mapping. For Alexa Smart Properties, the format is `amzn1.alexa.unit.did.{ID}`. For details about communication profile IDs, see Manage communication profiles.	String	Yes

Response

A successful response returns HTTP 200 OK. On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message. For details, see HTTP status codes.

Response body example

The successful response has no body.

Response body properties

The successful response has no body.

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` or `extension` isn't found.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

Delete an extension mapping

Delete an extension mapping between your property unit and an extension on your PBX.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To delete an extension mapping, make a DELETE request to /v1/communications/network/siptrunk/{trunkId}/extension/{extension}.

Request path and header example

Copied to clipboard.

DELETE /v1/communications/network/siptrunk/amzn1.comms.network.siptrunk.59216beb/extension/7201 HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	A trunk ID for the extension mapping.	String	Yes
`extension`	Path	Internal extension number for the unit. Typically, this string is a few digits of a number, but it might include alphanumeric characters.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

Response body example

The successful response has no body.

Response body properties

The successful response has no body.

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` or `extension` isn't found.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

List extensions in batch

Retrieve the mappings between the Alexa-enabled devices in rooms in your property and extensions on your PBX.

This operation is available in the following countries.

Healthcare	Hospitality	Senior Living	Core
US	US	US	US

Request

To retrieve the extension mapping between a unit and extension on your PBX, make a GET request to /v1/communications/network/siptrunk/{trunkId}/extensions.

Request path and header example

Copied to clipboard.

GET /v1/communications/network/siptrunk/amzn1.comms.network.siptrunk.59216beb/extensions HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json  
Authorization:  Bearer {access token}

Request path and header parameters

Parameter	Located in	Description	Type	Required
`trunkId`	Path	Trunk ID for the extension mapping.	String	Yes
`access token`	Header	Login with Amazon (LWA) token. For details, see Get an Access Token for SMAPI.	String	Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

Response body example

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: ca56ddf4-b5bd-11ec-b909-0242ac120002
Content-Type: application/json
{
  "paginationContext": {
    "totalCount": 1,
    "nextPageToken": "0"
  },
  "extensions": [
    {
      "extension": "7201",
      "routingType": "communication-profile",
      "commsProfileId": "amzn1.alexa.unit.did.abcdef1234"
    }
  ]
}

Response body properties

Property	Description	Type
`paginationContext`	Information about pagination.	Object
`paginationContext.totalCount`	Total number of trunks associated with the account.	Number
`paginationContext.nextPageToken`	Starting pointer of the current query.	String
`extensions[]`	Information about the extension mappings.	Array of objects
`extensions[].extension`	Internal extension for the unit. Typically, the extension is a few digits of a number, but might include alphanumeric characters.	String
`extensions[].routingType`	Routing type. Possible value: `communication-profile`.	Enum
`extensions[].commsProfileId`	Profile ID to attach the mapping. For Alexa Smart Properties, the format is `amzn1.alexa.unit.did.{ID}`. For details about communication profile IDs, see Manage communication profiles.	String

HTTP status codes

Status	Description
`200 OK`	The request succeeded.
`400 Bad Request`	A required parameter isn't present or is incorrectly formatted.
`401 Unauthorized`	The access token is missing or expired.
`403 Forbidden`	You don't have permission to perform the operation or the authentication token is invalid.
`404 Not Found`	The specified `trunkId` isn't found.
`429 Too Many Requests`	You made more API calls than the allowed limit.
`500 Internal Server Error`	An internal service error caused the request failure.

Was this page helpful?

Provide feedback

Last updated: Nov 28, 2023