Trunk Users
Trunk users usually represent the individual users in your phone system who may have soft phones or desk phones.
List trunk users in a trunk
Lists all trunk users for a given trunk.
This endpoint supports paging. By default the API will return 100 users, configurable up to a maximum of 1000 trunk's users 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.
path Parameters
trunkIdThe trunk ID
query Parameters
limitThe number of objects fetched per request. Default to 100, maximum is 1000
nextOptional next token for object pagination
externalIdThe external ID of the trunk user
Headers
AuthorizationAuthorization header bearing the access token
List trunk users in a trunk › Responses
Trunk users
Update a trunk user using external ID
Update a trunk user in the specified trunk by its external ID.
Updating all trunk users in the specified trunk is currently not supported.
path Parameters
trunkIdThe trunk ID
Headers
AuthorizationAuthorization header bearing the access token
Update a trunk user using external ID › Request Body optional
externalIdThe external ID of the user to update
assignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
fullNameThe user's full name
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
Update a trunk user using external ID › Responses
Successfully updated trunk user
displayNameThe display name of this directory entry.
extensionThe user's extension
externalIdThe external ID of the user
fullNameThe user's full name
idThe ID of the user
sipAddressThe users SIP address
trunkIdThe trunk ID that the user belongs to
typeassignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
twimlRedirectUrlRedirecting 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 user to a trunk
Creates a new trunk user in the specified trunk.
path Parameters
trunkIdThe trunk ID
Headers
AuthorizationAuthorization header bearing the access token
Add a new trunk user to a trunk › Request Body optional
extensionThe user's extension
externalIdThe external ID of the user
fullNameThe user's full name
assignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
Add a new trunk user to a trunk › Responses
Successfully created trunk user
displayNameThe display name of this directory entry.
extensionThe user's extension
externalIdThe external ID of the user
fullNameThe user's full name
idThe ID of the user
sipAddressThe users SIP address
trunkIdThe trunk ID that the user belongs to
typeassignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
twimlRedirectUrlRedirecting 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 user using external ID.
Delete a trunk user in the specified trunk.
Deleting all trunk users in the specified trunk is currently not supported.
path Parameters
trunkIdThe trunk ID
query Parameters
externalIdThe external ID of the trunk user
Headers
AuthorizationAuthorization header bearing the access token
Delete a trunk user using external ID. › Responses
Successfully deleted trunk user
Get a trunk user
Retrieve a trunk user resource, and its data.
path Parameters
trunkIdThe trunk ID
trunkUserIdThe trunk's user ID
Headers
AuthorizationAuthorization header bearing the access token
Get a trunk user › Responses
Trunk user
displayNameThe display name of this directory entry.
extensionThe user's extension
externalIdThe external ID of the user
fullNameThe user's full name
idThe ID of the user
sipAddressThe users SIP address
trunkIdThe trunk ID that the user belongs to
typeassignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
twimlRedirectUrlRedirecting 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 user
Update a trunk user in the specified trunk.
path Parameters
trunkIdThe trunk ID
trunkUserIdThe trunk's user ID
Headers
AuthorizationAuthorization header bearing the access token
Update a trunk user › Request Body optional
assignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
fullNameThe user's full name
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
Update a trunk user › Responses
Successfully updated trunk user
displayNameThe display name of this directory entry.
extensionThe user's extension
externalIdThe external ID of the user
fullNameThe user's full name
idThe ID of the user
sipAddressThe users SIP address
trunkIdThe trunk ID that the user belongs to
typeassignToUserEmailThe email of the Spoke user to assign this trunk user to.
Ignored if assignToUserId is provided.
Setting this field to null will unassign the current owner.
assignToUserIdThe Spoke user ID of the user to assign this trunk user to.
Setting this field to null will unassign the current owner.
departmentThe user's department
descriptionThe user's description
The optional list of emails
jobTitleThe user's job title
locationThe user's location
managerThe user's manager
The optional list of phone numbers
twimlRedirectUrlRedirecting 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 user
Delete a trunk user in the specified trunk.
path Parameters
trunkIdThe trunk ID
trunkUserIdThe trunk's user ID
Headers
AuthorizationAuthorization header bearing the access token
Delete a trunk user › Responses
Successfully deleted trunk user