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:
|
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. |
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. Note: The minimum character length is
8 and the maximum is 63. |
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: ).
|
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. |
vm_lang | No | String | The system prompt language used by the extension's
voicemail. Valid value: Note: Make sure that the desired
language exists in the PBX (Path: ).
|
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_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. 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:
|
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 Linkus Mobile Client. Valid value:
|
enb_desktop_client | No | Integer | Whether to enable Linkus Desktop Client. Valid value:
|
enb_web_client | No | Integer | Whether to enable Linkus Web Client. Valid value:
|
enb_pad_client | No | Integer | Whether to enable Linkus Pad Client (SDK). Valid value:
Note: This option takes effect ONLY
when you have integrated the Linkus
SDK for Android or Linkus
SDK for iOS. |
linkus_mobile_codec | No | String | Set codec for Linkus Mobile Client. Valid value:
|
enb_ice | No | String |
Whether to enable ICE (Interactive Connectivity Establishment) for Linkus Mobile Client. Valid value:
|
- Organization_Info
-
Table 2. 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:
available
: Availableaway
: Awaybusiness_trip
: Business Tripdo_not_disturb
: Do Not Disturb (DND)lunch
: Lunch Breakoff_work
: Off Work
enb_in_always_forward No Integer Whether to always forward internal incoming calls to a specific destination (Always condition). Valid value:
0
: Disable1
: Enable
in_always_forward_dest No String The destination type for internal call forwarding in Always condition. Valid value:
extension
: Extensionext_vm
: Extension Voicemailivr
: IVRring_group
: Ring Groupqueue
: Queuegroup_vm
: Group Voicemailmobile_number
: Mobile Numberexternal_num
: External Numberplay_greeting
: Play Greeting then Hang upend_call
: Hang Up
Note: When the destination type isext_vm
ormobile_number
, the system will automatically retrieve the corresponding destination value from the extension information.in_always_forward_prefix No String The parameter defines different settings depending on the destination type for internal call forwarding in Always condition. - When the destination type is
mobile_number
orexternal_num
, the parameter defines the dial-out prefix of the external destination number. - When the destination type is
play_greeting
, the parameter defines the play count of the greeting. The valid value is 1 - 5.
in_always_forward_value No String The destination for internal call forwarding in Always condition. This parameter is REQUIRED for the following destination types:
- When the destination type is
play_greeting
, this parameter defines the custom prompt file name. E.g.demo.wav
. - When the destination type is
extension
,ivr
,ring_group
,queue
, orgroup_vm
, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID2
.Note:- You can query the extension ID using Search Specific Extensions.
- You can query the ID of other destination options using Get Menu Options.
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:
0
: Disable1
: Enable
in_no_answer_forward_dest No String The destination type for internal call forwarding in No Answer condition. Valid value:
extension
: Extensionext_vm
: Extension Voicemailivr
: IVRring_group
: Ring Groupqueue
: Queuegroup_vm
: Group Voicemailmobile_number
: Mobile Numberexternal_num
: External Numberplay_greeting
: Play Greeting then Hang upend_call
: Hang Up
Note: When the destination type isext_vm
ormobile_number
, the system will automatically retrieve the corresponding destination value from the extension information.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. - When the destination type is
mobile_number
orexternal_num
, the parameter defines the dial-out prefix of the external destination number. - When the destination type is
play_greeting
, the parameter defines the play count of the greeting. The valid value is 1 - 5.
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:
- When the destination type is
play_greeting
, this parameter defines the custom prompt file name. E.g.demo.wav
. - When the destination type is
extension
,ivr
,ring_group
,queue
, orgroup_vm
, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID2
.Note:- You can query the extension ID using Search Specific Extensions.
- You can query the ID of other destination options using Get Menu Options.
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:
0
: Disable1
: Enable
in_busy_forward_dest No String The destination type for internal call forwarding in Busy condition. Valid value:
extension
: Extensionext_vm
: Extension Voicemailivr
: IVRring_group
: Ring Groupqueue
: Queuegroup_vm
: Group Voicemailmobile_number
: Mobile Numberexternal_num
: External Numberplay_greeting
: Play Greeting then Hang upend_call
: Hang Up
Note: When the destination type isext_vm
ormobile_number
, the system will automatically retrieve the corresponding destination value from the extension information.in_busy_forward_prefix No String The parameter defines different settings depending on the destination type for internal call forwarding in Busy condition. - When the destination type is
mobile_number
orexternal_num
, the parameter defines the dial-out prefix of the external destination number. - When the destination type is
play_greeting
, the parameter defines the play count of the greeting. The valid value is 1 - 5.
in_busy_forward_value No String The destination for internal call forwarding in Busy condition. This parameter is REQUIRED for the following destination types:
- When the destination type is
play_greeting
, this parameter defines the custom prompt file name. E.g.demo.wav
. - When the destination type is
extension
,ivr
,ring_group
,queue
, orgroup_vm
, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID2
.Note:- You can query the extension ID using Search Specific Extensions.
- You can query the ID of other destination options using Get Menu Options.
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:
0
: Disable1
: Enable
ex_always_forward_dest No String The destination type for external call forwarding in Always condition. Valid value:
extension
: Extensionext_vm
: Extension Voicemailivr
: IVRring_group
: Ring Groupqueue
: Queuegroup_vm
: Group Voicemailmobile_number
: Mobile Numberexternal_num
: External Numberplay_greeting
: Play Greeting then Hang upend_call
: Hang Up
Note: When the destination type isext_vm
ormobile_number
, the system will automatically retrieve the corresponding destination value from the extension information.ex_always_forward_prefix No String The parameter defines different settings depending on the destination type for external call forwarding in Always condition. - When the destination type is
mobile_number
orexternal_num
, the parameter defines the dial-out prefix of the external destination number. - When the destination type is
play_greeting
, the parameter defines the play count of the greeting. The valid value is 1 - 5.
ex_always_forward_value No String The destination for external call forwarding in Always condition. This parameter is REQUIRED for the following destination types:
- When the destination type is
play_greeting
, this parameter defines the custom prompt file name. E.g.demo.wav
. - When the destination type is
extension
,ivr
,ring_group
,queue
, orgroup_vm
, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID2
.Note:- You can query the extension ID using Search Specific Extensions.
- You can query the ID of other destination options using Get Menu Options.
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:
0
: Disable1
: Enable
ex_no_answer_forward_dest No String The destination type for external call forwarding in No Answer condition. Valid value:
extension
: Extensionext_vm
: Extension Voicemailivr
: IVRring_group
: Ring Groupqueue
: Queuegroup_vm
: Group Voicemailmobile_number
: Mobile Numberexternal_num
: External Numberplay_greeting
: Play Greeting then Hang upend_call
: Hang Up
Note: When the destination type isext_vm
ormobile_number
, the system will automatically retrieve the corresponding destination value from the extension information.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. - When the destination type is
mobile_number
orexternal_num
, the parameter defines the dial-out prefix of the external destination number. - When the destination type is
play_greeting
, the parameter defines the play count of the greeting. The valid value is 1 - 5.
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:
- When the destination type is
play_greeting
, this parameter defines the custom prompt file name. E.g.demo.wav
. - When the destination type is
extension
,ivr
,ring_group
,queue
, orgroup_vm
, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID2
.Note:- You can query the extension ID using Search Specific Extensions.
- You can query the ID of other destination options using Get Menu Options.
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:
0
: Disable1
: Enable
ex_busy_forward_dest No String The destination type for external call forwarding in Busy condition. Valid value:
extension
: Extensionext_vm
: Extension Voicemailivr
: IVRring_group
: Ring Groupqueue
: Queuegroup_vm
: Group Voicemailmobile_number
: Mobile Numberexternal_num
: External Numberplay_greeting
: Play Greeting then Hang upend_call
: Hang Up
Note: When the destination type isext_vm
ormobile_number
, the system will automatically retrieve the corresponding destination value from the extension information.ex_busy_forward_prefix No String The parameter defines different settings depending on the destination type for external call forwarding in Busy condition. - When the destination type is
mobile_number
orexternal_num
, the parameter defines the dial-out prefix of the external destination number. - When the destination type is
play_greeting
, the parameter defines the play count of the greeting. The valid value is 1 - 5.
ex_busy_forward_value No String The destination for external call forwarding in Busy condition. This parameter is REQUIRED for the following destination types:
- When the destination type is
play_greeting
, this parameter defines the custom prompt file name. E.g.demo.wav
. - When the destination type is
extension
,ivr
,ring_group
,queue
, orgroup_vm
, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID2
.Note:- You can query the extension ID using Search Specific Extensions.
- You can query the ID of other destination options using Get Menu Options.
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:
0
: Disable1
: Enable
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
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",
"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,
"number": "1000",
"caller_id": "5503301",
"reg_name": "Yeastar_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_all_reject_mode_for_endpoints":0,
"disable_international_call":1,
"disable_outb_call_outside_business_hours":1,
"disable_outb_call":0,
"outbound_route_permission":[69],
"enb_mobile_client":1,
"enb_desktop_client":1,
"enb_web_client":1,
"enb_pad_client": 1,
"linkus_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
},
{
"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
},
{
"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
},
{
"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
},
{
"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
},
{
"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
}
]
}
Response example
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"id": 233
}