en
zhThis is an old revision of the document!
Hangup
- Function:
hangup(uniqueid,targetagent,target,pwdtype,password,usertype,user,orgidentity)
- Description:
Hangup one call party or a list of parties
- Parameters:
| Params | Type | Description |
|---|---|---|
| uniqueid | String | the uniqueid of the calls you want to hangup, end with a comma |
| targetagent | String | If you don't have uniqueId, you need to put agent number. If you want to hangup group admin who is in spy, barge-in or whisper, put agent number, such as, group admin 2227 is spying agent 1986, put 1986 here if you need to hangup 2227. |
| target | String | hangup target:(channel,agent,caller,consult,all),uniqueId is required if you want to hangup a channel |
| pwdtype | String | Use plaintext or md5 password for agent or account |
| password | String | password |
| usertype | String | agent / account |
| user | String | Agent No. or Username |
| orgidentity | String | The identity string of the team |
- uniqueid example:
- Hangup one party: uniqueid,
- Hnagup: uniqueid1, uniqueid2,…uniqueidN,
- Return Format:
|Retuen|code|Retuen|message
- Type of the Return Value: String
- Return Values:
| Value | Description |
|---|---|
|Retuen|1|Retuen|message | <code>|Retuen|succeed|Retuen|message When uniqueid is not empty, message gives result for each uniqueid, ex: |Retuen|1|Retuen|4781:success,4782:failed |
|Retuen|2|Retuen|message | Failed||Messages |
