Trunk Queues

Trunk queues usually represent call queues or hunt groups in your phone system.

List trunk queues in a trunk

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

Lists all trunk queues for a given trunk.

This endpoint supports paging. By default the API will return 100 queues, configurable up to a maximum of 1000 trunk's queues 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 queues in a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

List trunk queues 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 queue

List trunk queues in a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

List trunk queues in a trunk › Responses

Trunk queues

TrunkQueuesResponse

ResponseMeta · required

TrunkQueue[] · required

Update a trunk queue using external ID

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

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

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

Update a trunk queue using external ID › path Parameters

trunkId

trunkId · required

The trunk ID

Update a trunk queue using external ID › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk queue using external ID › Request Body optional

UpdateTrunkQueueByExternalIdBody

externalId

string · required

The external ID of the queue to update

description

string

The queue's description

name

string

The queue's name

Update a trunk queue using external ID › Responses

Successfully updated trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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.

Add a new trunk queue to a trunk

POST

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

Creates a new trunk queue in the specified trunk.

Add a new trunk queue to a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

Add a new trunk queue to a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

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

CreateTrunkQueueBody

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

name

string · required

The queue's name

description

string

The queue's description

Add a new trunk queue to a trunk › Responses

Successfully created trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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}/trunkQueues

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

Example Request Body

{
  "description": "description",
  "extension": "extension",
  "externalId": "externalId",
  "name": "name"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "name": "name",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkQueue"
}

json

application/json

Delete a trunk queue using external ID.

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

Delete a trunk queue in the specified trunk.

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

Delete a trunk queue using external ID. › path Parameters

trunkId

trunkId · required

The trunk ID

Delete a trunk queue using external ID. › query Parameters

externalId

externalId · required

The external ID of the trunk queue

Delete a trunk queue using external ID. › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk queue using external ID. › Responses

Successfully deleted trunk queue

No data returned

Get a trunk queue

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues/{trunkQueueId}

Retrieve a trunk queue resource, and its data.

Get a trunk queue › path Parameters

trunkId

trunkId · required

The trunk ID

trunkQueueId

trunkQueueId · required

The trunk's queue ID

Get a trunk queue › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Get a trunk queue › Responses

Trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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 queue

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues/{trunkQueueId}

Update a trunk queue in the specified trunk.

Update a trunk queue › path Parameters

trunkId

trunkId · required

The trunk ID

trunkQueueId

trunkQueueId · required

The trunk's queue ID

Update a trunk queue › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk queue › Request Body optional

UpdateTrunkQueueBody

description

string

The queue's description

name

string

The queue's name

Update a trunk queue › Responses

Successfully updated trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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.

Delete a trunk queue

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues/{trunkQueueId}

Delete a trunk queue in the specified trunk.

Delete a trunk queue › path Parameters

trunkId

trunkId · required

The trunk ID

trunkQueueId

trunkQueueId · required

The trunk's queue ID

Delete a trunk queue › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk queue › Responses

Successfully deleted trunk queue

No data returned

Trunk Devices Trunk Users

Spoke API Reference

Trunk Queues

Trunk queues usually represent call queues or hunt groups in your phone system.

List trunk queues in a trunk

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

Lists all trunk queues for a given trunk.

List trunk queues in a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

List trunk queues 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 queue

List trunk queues in a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

List trunk queues in a trunk › Responses

Trunk queues

TrunkQueuesResponse

ResponseMeta · required

TrunkQueue[] · required

Update a trunk queue using external ID

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

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

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

Update a trunk queue using external ID › path Parameters

trunkId

trunkId · required

The trunk ID

Update a trunk queue using external ID › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk queue using external ID › Request Body optional

UpdateTrunkQueueByExternalIdBody

externalId

string · required

The external ID of the queue to update

description

string

The queue's description

name

string

The queue's name

Update a trunk queue using external ID › Responses

Successfully updated trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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.

Add a new trunk queue to a trunk

POST

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

Creates a new trunk queue in the specified trunk.

Add a new trunk queue to a trunk › path Parameters

trunkId

trunkId · required

The trunk ID

Add a new trunk queue to a trunk › Headers

Authorization

Authorization · required

Authorization header bearing the access token

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

CreateTrunkQueueBody

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

name

string · required

The queue's name

description

string

The queue's description

Add a new trunk queue to a trunk › Responses

Successfully created trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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}/trunkQueues

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

Example Request Body

{
  "description": "description",
  "extension": "extension",
  "externalId": "externalId",
  "name": "name"
}

json

Example Responses

{
  "description": "description",
  "displayName": "displayName",
  "extension": "extension",
  "externalId": "externalId",
  "id": "id",
  "name": "name",
  "sipAddress": "sipAddress",
  "trunkId": "trunkId",
  "twimlRedirectUrl": "twimlRedirectUrl",
  "type": "trunkQueue"
}

json

application/json

Delete a trunk queue using external ID.

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues

Delete a trunk queue in the specified trunk.

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

Delete a trunk queue using external ID. › path Parameters

trunkId

trunkId · required

The trunk ID

Delete a trunk queue using external ID. › query Parameters

externalId

externalId · required

The external ID of the trunk queue

Delete a trunk queue using external ID. › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk queue using external ID. › Responses

Successfully deleted trunk queue

No data returned

Get a trunk queue

GET

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues/{trunkQueueId}

Retrieve a trunk queue resource, and its data.

Get a trunk queue › path Parameters

trunkId

trunkId · required

The trunk ID

trunkQueueId

trunkQueueId · required

The trunk's queue ID

Get a trunk queue › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Get a trunk queue › Responses

Trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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 queue

PUT

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues/{trunkQueueId}

Update a trunk queue in the specified trunk.

Update a trunk queue › path Parameters

trunkId

trunkId · required

The trunk ID

trunkQueueId

trunkQueueId · required

The trunk's queue ID

Update a trunk queue › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Update a trunk queue › Request Body optional

UpdateTrunkQueueBody

description

string

The queue's description

name

string

The queue's name

Update a trunk queue › Responses

Successfully updated trunk queue

TrunkQueue

displayName

string · required

The display name of this directory entry.

extension

string · required

The queue's extension

externalId

string · required

The external ID of the queue

id

string · required

The ID of the queue

name

string · required

The queue's name

sipAddress

string · required

The queue's address (SIP)

trunkId

string · required

The trunk ID that the queue belongs to

type

string · const · required

Const value: trunkQueue

description

string

The queue's description

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.

Delete a trunk queue

DELETE

https://integration.spokephone.com

/trunks/{trunkId}/trunkQueues/{trunkQueueId}

Delete a trunk queue in the specified trunk.

Delete a trunk queue › path Parameters

trunkId

trunkId · required

The trunk ID

trunkQueueId

trunkQueueId · required

The trunk's queue ID

Delete a trunk queue › Headers

Authorization

Authorization · required

Authorization header bearing the access token

Delete a trunk queue › Responses

Successfully deleted trunk queue

No data returned

Trunk Devices Trunk Users