Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Speed Dials

A Speed Dial is a code that can used to quickly dial numbers that are called on a regular basis

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/speed-dial

Gets a list of all the active speed dials on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-03-23",
            "dial_code" : "123",
            "display_name" : "Yay Support Line",
            "target_number" : "+443301226000",
            "updated_on" : "2023-03-23",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/speed-dial/{uuid}

Gets the details for a specific speed dial on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Speed Dial to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-03-23",
        "dial_code" : "123",
        "display_name" : "Yay Support Line",
        "target_number" : "+443301226000",
        "updated_on" : "2023-03-23",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/voip/speed-dial

Creates a new Speed Dial

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- dial_code
- String
- True
The dial code used to trigger this speed dial
- display_name
- String
- True
An optional nickname for this speed dial
- target_number
- String
- True
The number to dial when this code is used

JSON all-fields example:

{
    "dial_code" : "123",
    "display_name" : "Yay Support Line",
    "target_number" : "+443301226000"
}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2023-03-23",
        "dial_code" : "123",
        "display_name" : "Yay Support Line",
        "target_number" : "+443301226000",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

PUT/voip/speed-dial/{uuid}

Updates the specified speed dial

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Speed Dial to be updated

PUT body

Name
Type
Required

- dial_code
- String
- True
The dial code used to trigger this speed dial
- display_name
- String
- True
An optional nickname for this speed dial
- target_number
- String
- True
The number to dial when this code is used

JSON all-fields example:

{
    "dial_code" : "123",
    "display_name" : "Yay Support Line",
    "target_number" : "+443301226000"
}

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-03-23",
        "dial_code" : "123",
        "display_name" : "Yay Support Line",
        "target_number" : "+443301226000",
        "updated_on" : "2023-03-23",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

POST/voip/speed-dial/bulk

Upload a CSV to bulk create new speed dial codes. Any conflicting codes will be overwritten.

Back to top

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details
DELETE/voip/speed-dial/{uuid}

Deletes the specified Speed Dial
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Speed Dial to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```