Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
en:custom_development_guide:apis:webservice:hangup [2016/09/05 07:57] liuxl created |
en:custom_development_guide:apis:webservice:hangup [2019/01/03 06:59] (current) donnie |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| *Function: | *Function: | ||
| - | <code>hangup(uniqueid, pwdtype, password, usertype, user, orgidentity)</code> | + | <code>hangup(uniqueid,targetagent,target,pwdtype,password,usertype,user,orgidentity)</code> |
| *Description: | *Description: | ||
| Line 11: | Line 11: | ||
| ^Params ^Type ^Description ^ | ^Params ^Type ^Description ^ | ||
| |uniqueid|String|the uniqueid of the calls you want to hangup, end with a comma| | |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| | |pwdtype|String|Use plaintext or md5 password for agent or account| | ||
| |password|String|password| | |password|String|password| | ||
| Line 22: | Line 24: | ||
| *Return Format: | *Return Format: | ||
| - | <code>|Return|code|Return|message</code> | + | <code>|Retuen|code|Retuen|message</code> |
| *Type of the Return Value: String | *Type of the Return Value: String | ||
| Line 28: | Line 30: | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| - | |<code>|Return|1|Return|message</code>|<code>Succeeded||Messages</code>| | + | |<code>|Retuen|1|Retuen|message</code>|<code>|Retuen|succeed|Retuen|message |
| - | |<code>|Return|2|Return|message</code>|<code>Failed||Messages</code>| | + | When uniqueid is not empty, message gives result for each uniqueid, ex: |
| + | |Retuen|1|Retuen|4781:success,4782:failed | ||
| + | </code>| | ||
| + | |<code>|Retuen|2|Retuen|message</code>|<code>Failed||Messages</code>| | ||
