Add an Extension

Add and configure a SIP extension.

Request URL

POST {base_url}/{api_path}/extension/create?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
type Yes String Extension type.

Valid value: SIP
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:
  • Must contain numbers, uppercase, and lowercase letters.
  • The minimum character length is 10 and the maximum is 63.
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:
  • Only numbers are allowed.
  • The maximum character length is 7.
caller_id No String Caller ID.
Note:
  • Numbers, letters, and special characters ( ) . - + * # are allowed.
  • The maximum character length is 31.
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:
  • 1 (default)
  • 2
  • 3
presence_status Yes String The current presence status of the extension.

Valid value:

  • available: Available
  • away: Away
  • business_trip: Business Trip
  • do_not_disturb: Do Not Disturb (DND)
  • lunch: Lunch Break
  • off_work: Off Work
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:

  • 0: Disable
  • 1: Enable
enb_vm_pin No Integer Whether to enable the voicemail PIN authentication.

Valid value:

  • 0: Disable
  • 1: Enable
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:

  • no: Do not send email notifications.
  • with_attach: Send a notification email with the new voicemail message attached as a .wav file.
  • without_attach: Send a notification email without attaching the new voicemail message.
vm_after_notification No String How to deal with the voicemail message after sending an email to notify the extension.

Valid value:

  • no: Keep the voicemail message in mailbox as unread.
  • mark_read: Keep the voicemail message in mailbox as read.
  • delete: Delete the voicemail message.
    Note: This value is supported only when new_vm_notification is set to with_attach.
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:

  • 0: Disable. When an incoming call is rejected on one endpoint, other endpoints still ring.
  • 1: Enable. When an incoming call is rejected on one endpoint, other endpoints stop ringing.
dtmf_mode No String DTMF mode.

Valid value:

  • rfc4733: RFC4733 (RFC2833)
  • info: Info
  • inband: Inband
  • auto: Auto
transport No String Transport protocol.

Valid value:

  • udp: UDP protocol
  • tcp: TCP protocol
  • tls: TLS protocol
enb_qualify No Integer Whether to enable Qualify.

Valid value:

  • 0: Disable
  • 1: Enable
enb_t38_support No Integer Whether to support T.38 fax.

Valid value:

  • 0: Disable
  • 1: Enable
enb_nat No Integer Whether to enable NAT.

Valid value:

  • 0: Disable
  • 1: Enable
enb_srtp No Integer Whether to enable SRTP.

Valid value:

  • 0: Disable
  • 1: Enable
allow_reg_remotely No Integer Whether to enable remote registration.

Valid value:

  • 0: Disable
  • 1: Enable
disable_outb_call No Integer Whether to restrict the extension from making outbound calls.

Valid value:

  • 0: Allow to make outbound calls.
  • 1: NOT allowed to make outbound calls.
disable_outb_call_outside_business_hours No Integer Whether to restrict the extension from making outbound calls outside Business Hours.

Valid value:

  • 0: Allow to make outbound calls outside Business Hours.
  • 1: NOT allowed to make outbound calls outside Business Hours.
disable_international_call No Integer Whether to restrict the extension from making international calls.

Valid value:

  • 0: Allow to make international calls.
  • 1: NOT allowed to make international calls.
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:

  • 0: Disable
  • 1: Enable
enb_desktop_client No Integer Whether to enable Linkus Desktop Client.

Valid value:

  • 0: Disable
  • 1: Enable
enb_web_client No Integer Whether to enable Linkus Web Client.

Valid value:

  • 0: Disable
  • 1: Enable
linkus_mobile_codec No String Set codec for Linkus Mobile Client.

Valid value:

  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
  • opus
enb_ice No String

Whether to enable ICE (Interactive Connectivity Establishment) for Linkus Mobile Client.

Valid value:

  • yes: Enable ICE.
  • no: Disable ICE.
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: Available
  • away: Away
  • business_trip: Business Trip
  • do_not_disturb: Do Not Disturb (DND)
  • lunch: Lunch Break
  • off_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: Disable
  • 1: Enable
in_always_forward_dest No String The destination type for internal call forwarding in Always condition.

Valid value:

  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up
Note: When the destination type is ext_vm or mobile_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 or external_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, or group_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 ID 2.
    Note:
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: Disable
  • 1: Enable
in_no_answer_forward_dest No String The destination type for internal call forwarding in No Answer condition.

Valid value:

  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up
Note: When the destination type is ext_vm or mobile_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 or external_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, or group_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 ID 2.
    Note:
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: Disable
  • 1: Enable
in_busy_forward_dest No String The destination type for internal call forwarding in Busy condition.

Valid value:

  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up
Note: When the destination type is ext_vm or mobile_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 or external_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, or group_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 ID 2.
    Note:
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: Disable
  • 1: Enable
ex_always_forward_dest No String The destination type for external call forwarding in Always condition.

Valid value:

  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up
Note: When the destination type is ext_vm or mobile_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 or external_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, or group_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 ID 2.
    Note:
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: Disable
  • 1: Enable
ex_no_answer_forward_dest No String The destination type for external call forwarding in No Answer condition.

Valid value:

  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up
Note: When the destination type is ext_vm or mobile_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 or external_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, or group_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 ID 2.
    Note:
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: Disable
  • 1: Enable
ex_busy_forward_dest No String The destination type for external call forwarding in Busy condition.

Valid value:

  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up
Note: When the destination type is ext_vm or mobile_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 or external_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, or group_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 ID 2.
    Note:
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: Disable
  • 1: Enable

Response parameters

Table 3.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
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,
    "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
}