Modify Agent Interface

1.Interface Introduction

Used to modify information about a specified agent. If you use a mobile phone to answer a call, you can use this interface to bind the mobile phone number without logging in to the system.

2.Interface request

  • HTTP request method:POST

  • Request url:{HOST}/v20160818/user/updateUser/accountId?sig=sig

  • When requesting, please replace {HOST} with connection data queryDomain name,ACCOUNTID is replaced with the account number, SIG is generated according to the authentication rules, please see the authentication document to see the specific generation rules.

  • Request frequency limit: 10 times / minute

  • Authentication document: Interface Authentication

3.The interface parameters are as follows:

Field Type Is necessary Remark
exten String yes Seat number, generally 8000, 8001, 8002, etc.
displayName String no Agent name (pass this parameter when needed to modify, pass new value)
email String no Email (pass this parameter when you need to modify, pass the new value)
password String no Login password (pass this parameter when you need to modify it, pass the new value)
mobile String no Mobile phone number (pass this parameter when you need to modify, pass the new value)

Note: Agent name and agent mobile phone number cannot be repeated

-Request body example:

{
    "exten":"8000",
    "displayName":"xhucen",
    "email":"xxx@xxx.com"
}

4.System returns

Field Meaning
code Response code
message Response message

code:

Code Meaning
200 Request succeeded
210 Agent does not exist
400 Request body parameter error
403 Incorrect authentication parameters
500 Server Error

Returns 200 examples:

{
    "code": 200,
    "message": "ok"
}

Returns 210 examples:

{
    "code": 210,
    "message": "user not found"
}

Returns 400 examples:

{
    "code": 400,
    "message": "Please check your parameters"
}

Returns 403 examples:

{
    "code": 403,
    "message": "Forbidden"
}

Returns 500 examples:

{
    "code": 500,
    "message": "Internal Server Error"
}