Follow-Me
Read and update supported Follow-Me settings for an active Voyced telephone number.
GET/v1/numbers/{telephone_number}/follow-me
Reads the current Follow-Me settings for one active number.
Example response
{
"success": true,
"data": {
"telephone_number": "+442012345678",
"mode": "Follow-me",
"sequence": "ordered",
"timeout_seconds": 30,
"max_forwards": 3,
"destinations": [{
"destination_id": "destination_26aeef57fd7c1df96715",
"name": "Office",
"number": "+442079460001",
"enabled": true,
"ring_seconds": 20,
"order": 1
}],
"destination_limit": 10
}
}Update Follow-Me
PUT/v1/numbers/{telephone_number}/follow-me
Updates the supported settings included in the request. When you send destinations, the supplied list replaces the current destination list.
Request body
{
"sequence": "ordered",
"timeout_seconds": 30,
"max_forwards": 3,
"destinations": [{
"destination_id": "destination_26aeef57fd7c1df96715",
"name": "Office",
"number": "+442079460001",
"enabled": true,
"ring_seconds": 20,
"period": ""
}]
}Supported values
| Field | Rules |
|---|---|
sequence | ordered, random or simultaneous. |
max_forwards | 1 to 10. |
destinations | Up to 10 destinations. Use a returned destination_id when updating an existing destination. |
ring_seconds | 0 to 90 seconds. |
Write permission is separate
A key with
follow_me.read cannot update settings unless follow_me.write is also enabled.1
Get a token
Request a temporary Sandbox bearer token.
2
Prepare the request
Select the endpoint and add a number when required.
3
Run and check
Review the HTTP status, response time and JSON.
Use a bearer token onlyThe page sends the token through the protected documentation proxy to Voyced Sandbox for this request. It is not saved. Reset or leave the page to clear the field.
The documentation proxy accepts approved Sandbox GET requests only. It cannot call Live. It does not place credentials in cookies, browser storage or URLs.