API Reference
  1. Call Routing

Create a ring group

post
https://api.emaktalk.com/api/v1/ring_groups

Creates a ring group, its member destinations and its call routing. The extension number is allocated for you — a ring_group_extension you send is ignored, and reserved-range numbers are refused. Several settings are fixed on create and cannot be chosen here: the group rings every member at once, it is always created enabled, and caller-ID name and number, calling permissions and call screening are left empty. If the destinations or the routing fail after the group itself is written, you get a 400 even though the ring group now exists — re-read the list before you retry. Success is 200, not 201.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null
required

Display name. It is required — the call routing is generated from it, and a missing name fails the create with 400.

string | null

Free-text description.

ring_group_destinations
array

The members to ring: [{destination_number, destination_delay, destination_prompt, destination_timeout, destination_description, destination_enabled}], created after the group itself.

ring_group_destinations
number | null

Seconds the group rings before the no-answer action takes over.

string | null

Category of the no-answer destination.

string | null

Action taken when nobody answers.

string | null

Argument for the no-answer action, such as the destination.

boolean

Whether every call to the group is forwarded instead of ringing members.

string | null

Where forwarded calls go.

string | null

Caller-ID name prefix shown on the members' phones as they ring.

string | null

Distinctive-ring value sent to the members' phones.

string | null

Ringback audio played to the caller while members ring.

string | null

Greeting played to the caller before members ring.

string | null

Missed-call notifier for calls nobody takes.

string | null

Where the missed-call notice goes, such as an email address.

boolean

Whether members' follow-me settings apply when the group rings them.

boolean

Whether members' own call-forward settings apply when the group rings them.

string

Reserved for internal use — omit it, and the group is created on your own account.

Responses

401

Missing or invalid API key.

Updated about 6 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?