SKYPE的API接口文档 - CN 下载本文

内容发布更新时间 : 2024/5/2 9:48:04星期一 下面是文章的全部内容请认真阅读。

Skype中文开发API文档

.协议4中采用ISO前置码,例如:USER mike LANGUAGE

en English.

? COUNTRY – 国家名称。例如:USER mike COUNTRY Estonia.在 协议4中采用ISO前置码,例如:USER mike COUNTRY Estonia. ? PROVINCE – 例如:USER mike PROVINCE Harjumaa. ? CITY – 例如:USER mike CITY Tallinn.

? PHONE_HOME – 例如:USER mike PHONE_HOME 3721111111. ? PHONE_OFFICE – 例如:USER mike PHONE_OFFICE 3721111111. ? PHONE_ MOBILE – 例如:USER mike PHONE_MOBILE 3721111111. ? HOMEPAGE – 例如:USER mike HOMEPAGE http: //www.joltid.com. ? ABOUT – 例如:USER mike ABOUT I am a nice person. 9 Skype Technologies S.A 12

? HASCALLEQUIPMENT – 回传值永远显示TRUE。例如:USER pamela HASCALLEQUIPMENT TRUE.

? BUDDYSTATUS – 例如:USER pamela BUDDYSTATUS 2. 可设定的 BUDDYSTATUS 值:

? 0 – 从未列入联络人名单。 ? 1 – 已从联络人名单内删除。 ? 2 – 有待授权。 ? 3 - 已加入联络人名单。

? ISAUTHORIZED – 已得到目前用户的授权。例如:USER pamela ISAUTHORIZED TRUE. 值: ? TRUE ? FALSE

? ISBLOCKED – 已被目前用户封锁。例如:USER spammer ISBLOCKED TRUE. 值: ? TRUE ? FALSE

? DISPLAYNAME – 例如:USER pamela DISPLAYNAME pam. ? ONLINESTATUS 用户上线状态。例如:USER mike ONLINESTATUS ONLINE. 值: ? UNKNOWN –未知用户。

? OFFLINE – 用户处于脱机状态(未联机)。如果目前用户未经其他用 户授权而查看他/她的上线状态,也会回传此值。 ? ONLINE - 用户处于上线状态。

? AWAY – 用户处于暂时离开状态(已有一定时间没活动)。 ? NA - 用户离开。

? DND - 用户处于“请勿打扰”模式。

? SKYPEOUT – 用户在SkypeOut 联络人名单内。

9

Skype中文开发API文档

SKYPEME (协议 2)

? LASTONLINETIMESTAMP - UNIX时间戳,仅供脱机用户查阅。例如: USER mike LASTONLINETIMESTAMP 1078959579. 通话对象

就通话对象的属性发出通知。 语法:CALL ID PROP VALUE ID – 通话标识符。 PROP - 属性名。适用属性:

? TIMESTAMP – 通话的时间(UNIX时间戳)。例如: CALL 17 TIMESTAMP 1078958218

? PARTNER_HANDLE – 例如:CALL 17 PARTNER_HANDLE mike ? PARTNER_DISPNAME – 例如:CALL 17 PARTNER_DISPNAME Mike Mann

10 Skype Technologies S.A 13

? CONF_ID – 如果CONF_ID>0,则为电话会议。例如:CALL 17 CONF_ID 0 ? TYPE – 通话类型。例如:CALL 17 TYPE OUTGOING_PSTN. 可设定的 TYPE值:

? INCOMING_PSTN – 从PSTN接入的来电。 ? OUTGOING_PSTN – 向PSTN拨出的电话。 ? INCOMING_P2P - 从P2P接入的来电。 ? OUTGOING_P2P – 向 P2P拨出的电话。

? STATUS – 通话状态。例如:CALL 17 STATUS FAILED.可设定的 STATUS值:

? UNPLACED – 从未打过的电话。 ? ROUTING – 通话正在转接中。 ? EARLYMEDIA –

采用pstn,则可能在实际建立通话之前,已开始播放媒体。例如可以出现来 电铃声或待接留言(线路繁忙,请稍候)等。 ? FAILED –

电话未接通。试图获得FAILUREREASON,以便了解详细原因。 ? RINGING –电话铃正在响。 ? INPROGRESS – 通话正在进行中。 ? ONHOLD – 通话处于暂候状态。 ? FINISHED – 通话完毕。 ? MISSED – 未接到来电。 ? REFUSED – 来电被拒接。

? BUSY – 对方电话占线,即已按下挂机键。 ? CANCELLED (协议 2)

? FAILUREREASON – 例如:CALL 17 FAILUREREASON 1 (数字表示).

10

Skype中文开发API文档

SUBJECT – 未使用。

? PSTN_NUMBER – 例如:CALL 17 PSTN_NUMBER 372123123. ? DURATION – 例如:CALL 17 DURATION 0.

? PSTN_STATUS –进行PSTN通话时从网关回传的错误字符串。

例如:CALL 26 PSTN_STATUS 6500 PSTN connection creation timeout. ? CONF_PARTICIPANTS_COUNT –

举行电话会议时非会议主持者的人数。可设定值:

? 0 – 通话不属于电话会议。因为会议主持人CONF_PARTICIPANTS_COUNT 永远为 0。

? 1 – 通话是以前的电话会议。 ? 2, 3, 4 – 通话属于电话会议。 ? CONF_PARTICIPANT n –

电话会议第n个参加者的句柄、通话类型与状态、以及参加者的姓名显示(仅限 非主持人)。例如:CALL 59 CONF_PARTICIPANT 1 echo123 INCOMING_P2P INPROGRESS Echo Test Service. 11 Skype Technologies S.A 14 MESSAGE物件

就讯息对象的属性发出通知。 语法:MESSAGE ID PROP VALUE ID – 讯息标识符。 PROP - 属性名。适用属性:

? TIMESTAMP – 讯息送出的时间(UNIX时间戳)。 例如:MESSAGE 21 TIMESTAMP 1078958218

? PARTNER_HANDLE – 例如:MESSAGE 21 PARTNER_HANDLE mike ? PARTNER_DISPNAME – 例如:MESSAGE 21 PARTNER_DISPNAME Mike Mann ? CONF_ID – 未使用。

? TYPE – 讯息类型。例如:MESSAGE 21 TYPE TEXT.可设定的 TYPE值:

? AUTHREQUEST – 请求授权。 ? TEXT – 即时消息或标题组。 ? CONTACTS – 联络人数据。 ? UNKNOWN.—其他。

? STATUS – 讯息状态。例如:MESSAGE 21 STATUS QUEUED. 可设定的STATUS值:

? SENDING – 讯息正被发送。 ? SENT – 讯息已被发送。 ? FAILED –

讯息发送失败。不妨发一个FAILUREREASON指令了解详细原因。

11

Skype中文开发API文档

RECEIVED – 讯息已被接收。 ? READ – 讯息已被读取。 ? IGNORED – 讯息被忽略。 ? QUEUED – 讯息被列入待发队列。

? FAILUREREASON – 例如:MESSAGE 21 FAILUREREASON 1 (数字表示)。

? BODY – 讯息内容主体。例如:MESSAGE 21 BODY Hi, what's up? 聊天讯息CHATMESSAGE对象 就聊天讯息对象的属性发出通知。

语法:CHATMESSAGE ID PROP VALUE ID – 聊天讯息标识符。 PROP - 属性名。适用属性:

? TIMESTAMP – 讯息送出的时间(UNIX时间戳)。 例如:MESSAGE 21 TIMESTAMP 1078958218 ? PARTNER_HANDLE – 例如:CHATMESSAGE 21 PARTNER_HANDLE mike

? PARTNER_DISPNAME – 例如:CHATMESSAGE 21 12 Skype Technologies S.A 15 PARTNER_DISPNAME Mike Mann

? TYPE – 讯息类型。例如:MESSAGE 21 TYPE TEXT.可设定的 TYPE值:

? SETTOPIC – 聊天题目变更。 ? SAID –即时消息。

? ADDEDMEMBERS – 邀请某人加入聊天。 ? SAWMEMBERS – 参加聊天者见过其他成员。 ? CREATEDCHATWITH – 已建立多人聊天。

? LEFT – 有人已退出聊天;如某人不能被加入聊天,也会作通知。 ? UNKNOWN.—其他。

? STATUS – 讯息状态。例如:MESSAGE 21 STATUS QUEUED. 可设定的STATUS值:

? SENDING – 讯息正被发送。 ? SENT – 讯息已被发送。 ? RECEIVED – 讯息已被接收。 ? READ – 讯息已被读取。

? LEAVEREASON – 与LEFT类型讯息同时使用。例如: CHATMESSAGE 21 LEAVEREASON UNSUBSCRIBE.可设定的 LEAVEREASON值:

? USER_NOT_FOUND – 没有找到用户。

? USER_INCAPABLE – 用户使用旧版Skype,因此无法加入多人聊天。 ? ADDER_MUST_BE_FRIEND –

12