PUT api/2.0/crm/voip/opers/{operatorId} This function requires authentication

Description

Updates a phone number operator with the parameters specified in the request.

Parameters

Name	Description	Type	Example
operatorId sent in url	Phone number operator ID	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
status sent in body	New operator status optional	Online, Paused, Offline	Online
allowOutgoingCalls sent in body	Defines if an operator allows making the outgoing calls or not optional	Bool value	true
record sent in body	Defines if an operator allows recording calls or not optional	Bool value	true
answerType sent in body	New operator answer type optional	Number, Sip, Client	Number
redirectToNumber sent in body	New redirect phone number	string	some text

Example

PUT api/2.0/crm/voip/opers/%229924256A-739C-462b-AF15-E652A3B1B6EB%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "status": "Online",
  "allowOutgoingCalls": true,
  "record": true,
  "answerType": "Number",
  "redirectToNumber": "some text"
}

Returns

Updated operator

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": "92eb52c8-bb93-4caf-87fb-46ea11530899",
    "Answer": 1,
    "ClientID": "ClientID",
    "Record": true,
    "TimeOut": 1,
    "Status": 1,
    "AllowOutgoingCalls": true,
    "PostFix": "PostFix",
    "PhoneNumber": "PhoneNumber",
    "RedirectToNumber": "RedirectToNumber"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>92eb52c8-bb93-4caf-87fb-46ea11530899</Id>
    <Answer>1</Answer>
    <ClientID>ClientID</ClientID>
    <Record>True</Record>
    <TimeOut>1</TimeOut>
    <Status>1</Status>
    <AllowOutgoingCalls>True</AllowOutgoingCalls>
    <PostFix>PostFix</PostFix>
    <PhoneNumber>PhoneNumber</PhoneNumber>
    <RedirectToNumber>RedirectToNumber</RedirectToNumber>
  </response>
</result>

PUT api/2.0/crm/voip/opers/{operatorId} This function requires authentication

Get information

Get help