Trunk Devices

Trunk devices usually represent real phones in communal areas, such as a conference phone or lunch room phone.

List trunk devices in a trunk

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Lists all trunk devices for a given trunk.

This endpoint supports paging. By default the API will return 100 devices, configurable up to a maximum of 1000 trunk's devices at a time. If the result from a previous call includes a next value in the result set you can use the value returned as the next parameter in the query string to retrieve the next page of results.

List trunk devices in a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

List trunk devices in a trunk › query Parameters

limit

limit · required

The number of objects fetched per request. Default to 100, maximum is 1000

next

Optional next token for object pagination

externalId

externalId

The external ID of the trunk device

List trunk devices in a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

List trunk devices in a trunk › Responses

Trunk devices

TrunkDevicesResponse

ResponseMeta · required

TrunkDevice[] · required

Update a trunk device using external ID

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Update a trunk device in the specified trunk by its external ID.

Updating all trunk devices in the specified trunk is currently not supported.

Update a trunk device using external ID › path Parameters

trunkId

trunkId · required

The trunk ID

Update a trunk device using external ID › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk device using external ID › Request Body optional

UpdateTrunkDeviceByExternalIdBody

externalId

string · required

The external ID of the device to update

description

string

The device's description

location

string

The device's location

model

string

The device's model

name

string

The device's name

product

string

The device's product

Update a trunk device using external ID › Responses

Successfully updated trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

PUT/trunks/{trunkId}/trunkDevices

curl https://integration.spokephone.com/trunks/:trunkId/trunkDevices \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}'

Example Request Body

{
  "description": "description",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkDevice"
}

json

application/json

Add a new trunk device to a trunk

POST

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Creates a new trunk device in the specified trunk.

Add a new trunk device to a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

Add a new trunk device to a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Add a new trunk device to a trunk › Request Body optional

CreateTrunkDeviceBody

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

name

string · required

The device's name

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

Add a new trunk device to a trunk › Responses

Successfully created trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

POST/trunks/{trunkId}/trunkDevices

curl https://integration.spokephone.com/trunks/:trunkId/trunkDevices \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "extension": "extension",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}'

Example Request Body

{
  "description": "description",
  "extension": "extension",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkDevice"
}

json

application/json

Delete a trunk device using external ID.

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Delete a trunk device in the specified trunk.

Deleting all trunk devices in the specified trunk is currently not supported.

Delete a trunk device using external ID. › path Parameters

trunkId

trunkId · required

The trunk ID

Delete a trunk device using external ID. › query Parameters

externalId

externalId · required

The external ID of the trunk device

Delete a trunk device using external ID. › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk device using external ID. › Responses

Successfully deleted trunk device

No data returned

Get a trunk device

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

Retrieve a trunk device resource, and its data.

Get a trunk device › path Parameters

trunkId

trunkId · required

The trunk ID

trunkDeviceId

trunkDeviceId · required

The trunk's device ID

Get a trunk device › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Get a trunk device › Responses

Trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

Update a trunk device

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

Update a trunk device in the specified trunk.

Update a trunk device › path Parameters

trunkId

trunkId · required

The trunk ID

trunkDeviceId

trunkDeviceId · required

The trunk's device ID

Update a trunk device › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk device › Request Body optional

UpdateTrunkDeviceBody

description

string

The device's description

location

string

The device's location

model

string

The device's model

name

string

The device's name

product

string

The device's product

Update a trunk device › Responses

Successfully updated trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

PUT/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

curl https://integration.spokephone.com/trunks/:trunkId/trunkDevices/:trunkDeviceId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}'

Example Request Body

{
  "description": "description",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkDevice"
}

json

application/json

Delete a trunk device

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

Delete a trunk device in the specified trunk.

Delete a trunk device › path Parameters

trunkId

trunkId · required

The trunk ID

trunkDeviceId

trunkDeviceId · required

The trunk's device ID

Delete a trunk device › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk device › Responses

Successfully deleted trunk device

No data returned

Trunks Trunk Queues

Spoke API Reference

Trunk Devices

Trunk devices usually represent real phones in communal areas, such as a conference phone or lunch room phone.

List trunk devices in a trunk

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Lists all trunk devices for a given trunk.

List trunk devices in a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

List trunk devices in a trunk › query Parameters

limit

limit · required

The number of objects fetched per request. Default to 100, maximum is 1000

next

Optional next token for object pagination

externalId

externalId

The external ID of the trunk device

List trunk devices in a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

List trunk devices in a trunk › Responses

Trunk devices

TrunkDevicesResponse

ResponseMeta · required

TrunkDevice[] · required

Update a trunk device using external ID

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Update a trunk device in the specified trunk by its external ID.

Updating all trunk devices in the specified trunk is currently not supported.

Update a trunk device using external ID › path Parameters

trunkId

trunkId · required

The trunk ID

Update a trunk device using external ID › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk device using external ID › Request Body optional

UpdateTrunkDeviceByExternalIdBody

externalId

string · required

The external ID of the device to update

description

string

The device's description

location

string

The device's location

model

string

The device's model

name

string

The device's name

product

string

The device's product

Update a trunk device using external ID › Responses

Successfully updated trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

PUT/trunks/{trunkId}/trunkDevices

curl https://integration.spokephone.com/trunks/:trunkId/trunkDevices \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}'

Example Request Body

{
  "description": "description",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkDevice"
}

json

application/json

Add a new trunk device to a trunk

POST

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Creates a new trunk device in the specified trunk.

Add a new trunk device to a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

Add a new trunk device to a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Add a new trunk device to a trunk › Request Body optional

CreateTrunkDeviceBody

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

name

string · required

The device's name

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

Add a new trunk device to a trunk › Responses

Successfully created trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

POST/trunks/{trunkId}/trunkDevices

curl https://integration.spokephone.com/trunks/:trunkId/trunkDevices \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "extension": "extension",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}'

Example Request Body

{
  "description": "description",
  "extension": "extension",
  "externalId": "externalId",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkDevice"
}

json

application/json

Delete a trunk device using external ID.

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices

Delete a trunk device in the specified trunk.

Deleting all trunk devices in the specified trunk is currently not supported.

Delete a trunk device using external ID. › path Parameters

trunkId

trunkId · required

The trunk ID

Delete a trunk device using external ID. › query Parameters

externalId

externalId · required

The external ID of the trunk device

Delete a trunk device using external ID. › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk device using external ID. › Responses

Successfully deleted trunk device

No data returned

Get a trunk device

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

Retrieve a trunk device resource, and its data.

Get a trunk device › path Parameters

trunkId

trunkId · required

The trunk ID

trunkDeviceId

trunkDeviceId · required

The trunk's device ID

Get a trunk device › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Get a trunk device › Responses

Trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

Update a trunk device

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

Update a trunk device in the specified trunk.

Update a trunk device › path Parameters

trunkId

trunkId · required

The trunk ID

trunkDeviceId

trunkDeviceId · required

The trunk's device ID

Update a trunk device › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk device › Request Body optional

UpdateTrunkDeviceBody

description

string

The device's description

location

string

The device's location

model

string

The device's model

name

string

The device's name

product

string

The device's product

Update a trunk device › Responses

Successfully updated trunk device

TrunkDevice

displayName

string · required

The display name of this directory entry.

extension

string · required

The device's extension

externalId

string · required

The external ID of the device

id

string · required

The ID of the device

name

string · required

The device's name

sipAddress

string · required

The device's address (SIP)

trunkId

string · required

The trunk ID that the device belongs to

type

string · const · required

Const value: trunkDevice

description

string

The device's description

location

string

The device's location

model

string

The device's model

product

string

The device's product

twimlRedirectUrl

string

Redirecting an inbound Twilio call to this target url will transfer the call to this entry. Use this URL to send a call to Spoke from Twilio Studio, Flex or your own TwiML application.

You can add additional parameters to this url to control how the call is handled by Spoke. See Routing Twilio Calls into Spoke for more information.

PUT/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

curl https://integration.spokephone.com/trunks/:trunkId/trunkDevices/:trunkDeviceId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --data '{
  "description": "description",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}'

Example Request Body

{
  "description": "description",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "location": "location",
  "model": "model",
  "name": "name",
  "product": "product",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkDevice"
}

json

application/json

Delete a trunk device

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkDevices/{trunkDeviceId}

Delete a trunk device in the specified trunk.

Delete a trunk device › path Parameters

trunkId

trunkId · required

The trunk ID

trunkDeviceId

trunkDeviceId · required

The trunk's device ID

Delete a trunk device › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk device › Responses

Successfully deleted trunk device

No data returned

Trunks Trunk Queues