en
zhThis is an old revision of the document!
Hangup
- Function:
hangup(uniqueid, 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 | 目标坐席工号，要操作哪个坐席的通话。uniqueid为空时，此项必填。uniqueid不为空时，此项可为空。如果挂断监听，强插，密语中的坐席组长(target=groupadmin)，此处需要填写被监听，强插，密语的坐席工号。如2227组长监听1986，欲挂断2227，此处需要填写1986。 |
| target | String | 挂机对象(channel,agent,caller,consult,all),channel必须传uniqueid，挂断相应uniqueid的通话,agent挂断目标坐席通话,caller挂断客户,consult如果传了uniqueid 则只挂uniqueid 相应的咨询方，如果没传，就按从旧到新的顺序挂断所有咨询方的通话,all挂断目标坐席相关所有通话，如果被监听，强插，同时挂断组长通话,groupadmin当目标坐席被监听，强插，密语时，用于挂断组长的通话，即结束组长的监听，强插，密语状态。 |
| 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:
|Return|code|Return|message
- Type of the Return Value: String
- Return Values:
| Value | Description |
|---|---|
|Return|1|Return|message | <code>|Retuen|成功|Retuen|信息描述 当uniqueid不为空时，message为每个uniqueid执行挂断的结果，举例 |Retuen|1|Retuen|4781:success,4782:failed success代表挂断成功 failed代表挂断失败 |
|Return|2|Return|message | Failed||Messages |
