Edit an Extension

Edit extension settings, such as Caller ID name, concurrent registrations, email address, etc.

Request URL

{base_url}/{api_path}/extension/update?token={token}

Request parameters

Parameter Required Type Description
number Yes String Extension number.
Note:
  • Only numbers are allowed.
  • The maximum length is 7.
username No String Caller ID name.
Note: The following characters are NOT allowed:

! % . @ : ; & " ' \ < >` $
registername No String Registration name.
Note:
  • Only alphanumerics are allowed.
  • The maximum length is 31.
registerpassword No String Registration password.
Note:

Only alphanumerics and the following characters are allowed: ~ ^ * - _ ?

Strong password is required by default.
  • Must contain non-consecutive numbers, uppercase and lowercase.
  • The minimum length is 16.
  • Do not contain "Extension" and "Caller ID Name" of this extension.
callerid No String Caller ID.
Note:
  • Only alphanumerics are allowed.
  • The maximum length is 31.
maxregistrations No Integer Maximum concurrent registrations allowed.

Valid values: 1-4
loginpassword No String Login password.
Note: Only alphanumerics and the following characters are allowed: ~ ^ * - _ ?

Strong password is required by default.

  • Must contain non-consecutive numbers, uppercase and lowercase.
  • The minimum length is 10.
  • Do not contain "Extension" and "Caller ID Name" of this extension.
email No String Email address.
Note:
  • Must be in the format of email address.
  • Space and the following characters are NOT allowed:# ; , [ ] = & " ' \ <> ` $
mobile No Integer Mobile number.
Note:
  • When Call Forwarding destination is set to Mobile Number, this parameter is required.
  • Only numbers are allowed.
  • The maximum length is 31.
hasvoicemail No String Whether to enable Enable Voicemail feature or not.

Valid values:

  • on: enable
  • off: disable
vmsecret No Integer Voicemail password.
Note:
  • Only numbers are allowed.
  • The maximum length is 63.
enablevmtoemail No String Whether to enable Send Voicemail to Email feature or not.

Valid values:

  • off: disable
  • on: enable. Send voicemail to extension user's email.
  • custom: Send voicemail to custom email.
alwaysforward No String Whether to enable Always Call Forwarding feature or not.

Valid values:

  • on: enable
  • off: disable
atransferto No String The destination of alwaysforward.

Valid values:

  • Voicemail
  • Extension
  • Mobile Number
  • Custom Number
atransferext No Integer When atransferto is Extension, the extension number should be configured.
atransferprefix No Integer When atransferto is Mobile Number or Custom Number, prefix may need to be configured according to outbound routes.
Note:
  • Only numbers are allowed.
  • The maximum length is 7.
atransfernum No Integer When atransferto is Custom Number, phone number must be configured.
Note:
  • Only numbers are allowed.
  • The maximum length is 15.
noanswerforward No String Whether to enable No Answer Call Forwarding feature or not.

Valid values:

  • on: enable
  • off: disable
ntransferto No String The destination of noanswerforward.

Valid values:

  • Voicemail
  • Extension
  • Mobile Number
  • Custom Number
ntransferext No Integer When ntransferto is Extension, the extension number should be configured.
ntransferprefix No Integer When ntransferto is Mobile Number or Custom Number, prefix may need to be configured according to outbound routes.
Note:
  • Only numbers are allowed.
  • The maximum length is 7.
ntransfernum No Integer When ntransferto is Custom Number, phone number must be configured.
Note:
  • Only numbers are allowed.
  • The maximum length is 15.
busyforward No String Whether to enable When Busy Call Forwarding feature or not.

Valid values:

  • on: enable
  • off: disable
btransferto No String The destination of busyforward.

Valid values:

  • Voicemail
  • Extension
  • Mobile Number
  • Custom Number
btransferext No Integer When btransferto is Extension, the extension number should be configured.
btransferprefix No Integer When btransferto is Mobile Number or Custom Number, prefix may need to be configured according to outbound routes.
Note:
  • Only numbers are allowed.
  • The maximum length is 7.
btransfernum No Integer When btransferto is Custom Number, phone number must be configured.
Note:
  • Only numbers are allowed.
  • The maximum length is 15.
allowbeingmonitored No String Whether to enable Allow Being Monitored feature or not.

Valid values:

  • on: enable
  • off: disable
monitormode No String Monitor mode.

Valid values:

  • Disabled
  • Extensive
  • Listen
  • Whisper
  • Barge-in
ringtimeout No String Ring timeout in seconds.
maxduration No String The maximum call duration allowed in seconds.
dnd No String Whether to enable DND feature or not.

Valid values:

  • on: enable
  • off: disable
callrestriction No String Whether to enable Outbound Restriction feature or not.

Valid values:

  • on: enable
  • off: disable
agentid No String The agent ID to be announced in the greeting prompt when users call to a queue. By default, the parameter is null, which means that the extension number will be announced.
Tip: Call extension/update to edit the extension agentid.
selectoutroute No String The outbound routes that are available to the extension.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Set the username of extension 1002 to Amy, keeping other settings unchanged.

POST /api/v2.0.0/extension/update?token=7afa377107feb9566654d5dd3a9a2a93
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com

{
	"number": "1002",
	"username": "Amy"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}