Add an Extension
Add and configure a SIP extension.
Request URL
POST {base_url}/{api_path}/extension/create?access_token={access_token}
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| type | Yes | String | Extension type. Valid value: SIP |
| avatar | No | String | The file ID of the extension's avatar.Note:
|
| first_name | No | String | First name. |
| last_name | No | String | Last name. |
| email_addr | No | String | Email address. |
| mobile_number | No | String | Mobile number. |
| user_password | Yes | String | User password.Note:
|
| role_id | No | Integer | The ID of a user role. Note:You can query user role's ID using Get Menu Options. |
| organization_list | No | Array <Organization_Info> | The organization(s) to which the extension belongs.Note:This parameter is required if the Organization Management feature is enabled. |
| title | No | String | The job title of the extension user. |
| email_language | No | Striing | The language of email notifications for the extension. Valid value:
|
| user_lang | No | String | The language of the system prompts heard by the extension during a call.Valid value: follow_system or one of the prompt language existed in PBX System Prompt (e.g. German).Note:You can query the available system prompts using Get Menu Options. |
| vm_lang | No | String | The language of the system prompts heard by caller when they access the extension's voicemail box. Valid value: follow_system or one of the prompt language existed in PBX System Prompt (e.g. German). Note:You can query the available system prompts using Get Menu Options. |
| number | Yes | String | Extension number.Note:
|
| caller_id | No | String | Caller ID.Note:
|
| reg_name | Yes | String | Registration name.Note:The maximum character length is 63. |
| reg_password | Yes | String | Registration password. |
| concurrent_registrations | Yes | Integer | IP phone concurrent registrations.Valid value:
|
| presence_status | Yes | String | The current presence status of the extension. Valid value:
|
| presence_list | No | Array <Presence_Setting> | The list of the presence settings. |
| presence_mobile_prefix | No | String | The dial-out prefix of the mobile number for the "Ring the Mobile Number Simultaneously" feature. |
| agent_id | No | String | The agent ID that will be announced in the greeting prompt to callers when their inbound calls are answered by queue agent. By default, the extension number will be announced. Note:Agent ID will be announced when Agent ID Announcement is enabled for queues on PBX web portal (Path: Call Features > Queue > Preferences > Announcement). |
| enb_vm | No | Integer | Whether to enable the voicemail. Valid value:
|
| enb_vm_pin | No | Integer | Whether to enable the voicemail PIN authentication. Valid value:
|
| vm_pin | No | String | The PIN code to access voicemail. |
| new_vm_notification | No | String | Whether to notify the extension when receiving a new voicemail message, and how to notify. Valid value:
|
| vm_after_notification | No | String | How to deal with the voicemail message after sending an email to notify the extension. Valid value:
|
| enb_vm_play_datetime | No | Integer | Whether to announce the message arrival time before playing the voicemail message.
|
| vm_play_time_format | No | String | Specify the time format for announcing the message arrival time. Valid value:
|
| enb_all_busy_mode_for_endpoints | No | Integer | Whether to forward new incoming calls to the Busy destination when any endpoint registered to the extension is busy on a call. Valid value:
|
| enb_all_reject_mode_for_endpoints | No | Integer | Whether to stop ringing other endpoints when an incoming call is rejected on one of the endpoints (with the extension registered). Valid value:
|
| dtmf_mode | No | String | DTMF mode. Valid value:
|
| transport | No | String | Transport protocol(s). Valid value:
|
| enb_qualify | No | Integer | Whether to enable Qualify. Valid value:
|
| enb_t38_support | No | Integer | Whether to support T.38 fax. Valid value:
|
| enb_nat | No | Integer | Whether to enable NAT. Valid value:
|
| enb_srtp | No | Integer | Whether to enable SRTP. Valid value:
|
| allow_reg_remotely | No | Integer | Whether to enable remote registration. Valid value:
|
| disable_outb_call | No | Integer | Whether to restrict the extension from making outbound calls. Valid value:
|
| disable_outb_call_outside_business_hours | No | Integer | Whether to restrict the extension from making outbound calls outside Business Hours. Valid value:
|
| disable_international_call | No | Integer | Whether to restrict the extension from making international calls. Valid value:
|
| max_outb_call_duration | No | Integer | Specify the maximum call duration of an outbound call made from the extension. Valid value:
|
| outbound_route_permission | No | Array <Integer> | The unique ID(s) of outbound route(s) that the extension is allowed to use.Note:
|
| enb_mobile_client | No | Integer | Whether to enable Simu Connect Mobile Client. Valid value:
|
| enb_desktop_client | No | Integer | Whether to enable Simu Connect Desktop Client. Valid value:
|
| enb_web_client | No | Integer | Whether to enable Simu Connect Web Client. Valid value:
|
| enb_pad_client | No | Integer | Whether to enable Simu Connect Pad Client (SDK). Valid value:
|
| simuconnect_mobile_codec | No | String | Set codec for Simu Connect Mobile Client. Valid value:
|
| enb_ice | No | String | Whether to enable ICE (Interactive Connectivity Establishment) for Simu Connect Mobile Client. Valid value:
|
| client_conf_list | No | Array <Simu Connect_Clients_Setting> | The list of the Simu Connect Clients settings. |
| moh | No | String | The name of the MoH (Music on Hold) playlist whose audio is played when the extension user places a call on hold. Note:You can query the name of MoH playlists using Query MoH Playlists. |
| call_forward_moh | No | String | The name of the MoH (Music on Hold) playlist whose audio is played for the caller when the call is forwarded to another destination. Note:You can query the name of MoH playlists using Query MoH Playlists. |
| ringback_tone_moh | No | String | The filename of custom prompt (e.g. demo.wav) played for the caller before the extension user answers the call. Note:You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt"). |
| vm_greeting | No | String | The filename of the voicemail greeting (e.g. demo.wav). Note:You can query the filename of voicemail greetings using Query Extension Voicemail Greeting List. |
Organization_Info
| Parameter | Required | Type | Description |
|---|---|---|---|
| value | Yes | String | The unique ID of an organization. Note:You can query organization's ID using Get Menu Options. |
Presence_Setting
| Parameter | Required | Type | Description |
|---|---|---|---|
| status | Yes | String | Extension presence. Valid value:
|
| enb_in_always_forward | No | Integer | Whether to always forward internal incoming calls to a specific destination (Always condition). Valid value:
|
| in_always_forward_dest | No | String | The destination type for internal call forwarding in Always condition. Valid value:
|
| in_always_forward_prefix | No | String | The parameter defines different settings depending on the destination type for internal call forwarding in Always condition.
|
| in_always_forward_value | No | String | The destination for internal call forwarding in Always condition. This parameter is REQUIRED for the following destination types:
|
| in_always_forward_num | No | String | The external number of the external_num destination for internal call forwarding in Always condition. |
| enb_in_no_answer_forward | No | Integer | Whether to forward internal calls to a specific destination when the calls are not answered (No Answer condition). Valid value:
|
| in_no_answer_forward_dest | No | String | The destination type for internal call forwarding in No Answer condition. Valid value:
|
| in_no_answer_forward_prefix | No | String | The parameter defines different settings depending on the destination type for internal call forwarding in No Answer condition.
|
| in_no_answer_forward_value | No | String | The destination for internal call forwarding in No Answer condition. This parameter is REQUIRED for the following destination types:
|
| in_no_answer_forward_num | No | String | The external number of the external_num destination for internal call forwarding in No Answer condition. |
| enb_in_busy_forward | No | Integer | Whether to forward internal calls to a specific destination when the extension is busy (Busy condition). Valid value:
|
| in_busy_forward_dest | No | String | The destination type for internal call forwarding in Busy condition. Valid value:
|
| in_busy_forward_prefix | No | String | The parameter defines different settings depending on the destination type for internal call forwarding in Busy condition.
|
| in_busy_forward_value | No | String | The destination for internal call forwarding in Busy condition. This parameter is REQUIRED for the following destination types:
|
| in_busy_forward_num | No | String | The external number of the external_num destination for internal call forwarding in Busy condition. |
| enb_ex_always_forward | No | Integer | Whether to always forward external calls to a specific destination (Always condition). Valid value:
|
| ex_always_forward_dest | No | String | The destination type for external call forwarding in Always condition. Valid value:
|
| ex_always_forward_prefix | No | String | The parameter defines different settings depending on the destination type for external call forwarding in Always condition.
|
| ex_always_forward_value | No | String | The destination for external call forwarding in Always condition. This parameter is REQUIRED for the following destination types:
|
| ex_always_forward_num | No | String | The external number of the external_num destination for external call forwarding in Always condition. |
| enb_ex_no_answer_forward | No | Integer | Whether to forward external calls to a specific destination when the calls are not answered (No Answer condition). Valid value:
|
| ex_no_answer_forward_dest | No | String | The destination type for external call forwarding in No Answer condition. Valid value:
|
| ex_no_answer_forward_prefix | No | String | The parameter defines different settings depending on the destination type for external call forwarding in No Answer condition.
|
| ex_no_answer_forward_value | No | String | The destination for external call forwarding in No Answer condition. This parameter is REQUIRED for the following destination types:
|
| ex_no_answer_forward_num | No | String | The external number of the external_num destination for external call forwarding in No Answer condition. |
| enb_ex_busy_forward | No | Integer | Whether to forward external calls to a specific destination when the extension is busy (Busy condition). Valid value:
|
| ex_busy_forward_dest | No | String | The destination type for external call forwarding in Busy condition. Valid value:
|
| ex_busy_forward_prefix | No | String | The parameter defines different settings depending on the destination type for external call forwarding in Busy condition.
|
| ex_busy_forward_value | No | String | The destination for external call forwarding in Busy condition. This parameter is REQUIRED for the following destination types:
|
| ex_busy_forward_num | No | String | The external number of the external_num destination for external call forwarding in Busy condition. |
| ring_timeout | Yes | Integer | The ringing timeout for incoming calls (Unit: Second). Valid value: 5 - 300 |
| enb_ring_mobile | No | Integer | Whether the mobile phone will ring simultaneously when the extension rings. Valid value:
|
| enb_accept_call_from_rg | No | Integer | Whether to accept incoming calls from ring group when the extension is in specific presence status. Valid value:
|
| vm_greeting | No | String | The filename of the voicemail greeting (e.g. demo.wav). Note:You can query the filename of voicemail greetings using Query Extension Voicemail Greeting List. |
SimuConnect_Clients_Setting
| Parameter | Required | Type | Description |
|---|---|---|---|
| client | Yes | String | The type of Simu Connect Client for which you want to configure features such as call waiting, auto-answer for paging/intercom calls, or auto-answer for non-paging/intercom calls. Valid value:
|
| enb_call_waiting | No | Integer | Whether to allow the extension to receive another call while already on the phone. Valid value:
|
| enb_auto_answer | No | Integer | Whether to automatically answer non-paging/intercom calls. Valid value:
|
| auto_answer_delay_time | No | Integer | The delay time before automatically answering non-paging/intercom calls (Unit: Second). Valid value: 0 - 60Note:0 indicates that incoming non-paging/intercom calls will be auto-answered immediately. |
| enb_auto_answer_tone | No | Integer | Whether to alert the extension with a tone when a non-paging/intercom call is automatically answered. Valid value:
|
| enb_auto_answer_paging | No | Integer | Whether to automatically answer paging/intercom calls. Valid value:
|
| enb_auto_answer_paging_barge | No | Integer | Whether to automatically answer paging/intercom calls during an active call. Valid value:
|
| enb_auto_answer_paging_tone | No | Integer | Whether to alert the extension with a tone when a paging/intercom call is automatically answered. Valid value:
|
| max_clients | Yes | Integer | The maximum number of Simu Connect Clients that can be simultaneously logged in to the extension.Valid value:
|
Response parameters
| Parameter | Type | Description |
|---|---|---|
| errcode | Integer | Returned error code.
|
| errmsg | String | Returned message.
|
| id | Integer | The unique ID of the extension. |
Examples
Request example
POST /openapi/v1.0/extension/create?access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz
Host: 192.168.5.150:8088
Content-Type: application/json
{
"type": "SIP",
"avatar":"myYtwrWoRmxBeyGrd0ff1e60-2b53-4d17-8a13-736923dab108",
"first_name": "Terrell",
"last_name": "Smith",
"email_addr": "terrell@sample.com",
"mobile_number": "15880987652",
"user_password": "Userpwd1011",
"organization_list":[{"value":"1"},{"value":"2"}],
"role_id": 1,
"email_language":"en",
"user_lang": "sound-en",
"vm_lang":"follow_system",
"number": "1000",
"caller_id": "5503301",
"reg_name": "Cloud_One_ext",
"reg_password": "Regpwd1011",
"concurrent_registrations": 1,
"presence_status": "available",
"enb_all_reject_mode_for_endpoints":1,
"dtmf_mode": "rfc4733",
"transport": "udp",
"allow_reg_remotely": 0,
"agent_id":"5630",
"enb_vm":1,
"enb_vm_pin":1,
"vm_pin":"8573",
"new_vm_notification":"with_attach",
"vm_after_notification":"delete",
"enb_vm_play_datetime": 0,
"vm_play_time_format": "follow_system",
"enb_all_busy_mode_for_endpoints": 1,
"enb_all_reject_mode_for_endpoints":0,
"disable_international_call":1,
"disable_outb_call_outside_business_hours":1,
"disable_outb_call":0,
"max_outb_call_duration": -1,
"outbound_route_permission":[69],
"enb_mobile_client":1,
"enb_desktop_client":1,
"enb_web_client":1,
"enb_pad_client": 1,
"simuconnect_mobile_codec": "g729",
"enb_ice":"yes",
"presence_mobile_prefix": "86",
"presence_list": [
{
"status": "available",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "external_num",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "123123",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ivr",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "1",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "end_call",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 1,
"ring_timeout": 30,
"enb_accept_call_from_rg": 1
},
{
"status": "away",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ring_group",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "1",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "queue",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "1",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "group_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "1",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "play_greeting",
"ex_busy_forward_prefix": "1",
"ex_busy_forward_value": "demo.wav",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"status": "business_trip",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "mobile_number",
"in_no_answer_forward_prefix": "123",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "external_num",
"in_busy_forward_prefix": "543",
"in_busy_forward_value": "",
"in_busy_forward_num": "5235235235",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "group_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "1",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"status": "do_not_disturb",
"enb_in_always_forward": 1,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ext_vm",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 1,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "ext_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"status": "lunch",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ext_vm",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "ext_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 1,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"status": "off_work",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ext_vm",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "ext_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
}
],
"client_conf_list": [
{
"client": "simuconnectweb",
"enb_call_waiting": 1,
"enb_auto_answer": 0,
"enb_auto_answer_paging": 1,
"enb_auto_answer_paging_barge": 0,
"enb_auto_answer_paging_tone": 1,
"max_clients": 2
},
{
"client": "simuconnectdesktop",
"enb_call_waiting": 1,
"enb_auto_answer": 1,
"auto_answer_delay_time": 10,
"enb_auto_answer_tone": 1,
"enb_auto_answer_paging": 0,
"enb_auto_answer_paging_barge": 0,
"enb_auto_answer_paging_tone": 1,
"max_clients": 2
},
{
"client": "simuconnectmobile",
"enb_call_waiting": 0,
"enb_auto_answer": 1,
"auto_answer_delay_time": 5,
"enb_auto_answer_tone": 1,
"enb_auto_answer_paging": 1,
"enb_auto_answer_paging_barge": 1,
"enb_auto_answer_paging_tone": 1,
"max_clients": 3
}
]
}