微信呼叫事件通知回调

设计中

POST

/v2/wx-voip/server/notification

请求参数

Header 参数

X-Tg-Signed-Headers

string

必需

参与预算签名的header

示例值:

x-tg-app-id;x-tg-date

X-Tg-App-Id

string

必需

开发者帐号的APPID

默认值:

Accept-Language

string

必需

请求端的本地语言（zh-cn, zh-tw, en-us, ja, ko, vi, es, pt, ru, tr, de, it, fr, pl, th, ar）

默认值:

示例值:

zh-cnzh-twen-usjakoviesptrutrdeitfrplthar

Authorization

string

必需

服务端接口时传入签名计算后的字符串。客户端APP传入用户登陆态数据access_token。两者不要混用。

默认值:

X-Tg-Date

string

必需

当前请求的UTC+0时间（注意时区，不是本地时区）

默认值:

20060102T150405Z

X-Tg-Content-Sha256

string

必需

将BODY数据进行SHA256计算后的值

X-Tg-Algorithm

string

必需

目前服务端接口使用的签名算法的版本号和哈希算法

默认值:

TGV1-HMAC-SHA256

Content-Type

string

必需

默认值:

application/json

Content-Length

string

必需

Body的字符串长度

Body 参数application/json

ToUserName

string

消息接收方

必需

对应微信官方消息的ToUserName字段

FromUserName

string

消息发送方

必需

对应微信官方消息的FromUserName字段

CreateTime

integer

消息发送时间

必需

对应微信官方消息的CreateTime字段

MsgType

string

消息类型

必需

对应微信官方消息的MsgType字段

Event

string

事件名称

必需

对应微信官方消息的Event字段

Action

string

消息动作名称

必需

对应微信官方消息的Action字段

RoomId

string

本次通话的房间id

必需

对应微信官方消息的RoomId字段

SessionKey

string

本次通话的 sessionkey

必需

对应微信官方消息的SessionKey字段

ServerToken

string

本次通话的服务端凭证

必需

对应微信官方消息的ServerToken字段

Payload

string

发起通话时第三方传入的自定义payload

必需

对应微信官方消息的Payload字段

ModelId

string

设备硬件ID

必需

对应微信官方消息的ModelId字段，如果为空，则对应Payload.model_id

string

设备ID

必需

对应微信官方消息的Sn字段，如果为空，则对应Payload.uuid字段

示例

true,action,join_voip_room,string,对应微信官方消息的Action字段
true,payload,eyJ1dWlkIjoiMTcwMkQ4T0JZV1dRIiwiYXBwX2lkIjoid3g5NTE4NWQwYWJlZmQ0YTBlIiwibW9kZWxfaWQiOiJzQ3hNSzNWdFVob0JySUQ1S1lHa3VRIiwiYWN0Ijoiam9pbiJ9,string,对应微信官方消息的Payload字段
true,server_token,Ig0Sojy+PQr6jT3avJpDjweFm9ZFlyQFIiKJLk5tvahcI/gMlbZSrz47Kp/S7I9B/930PKi67Aq+nHArhfXWb/T75CpCzy2dtLp1fxYP1/0=,string,对应微信官方消息的ServerToken字段
true,openid,o7XwO7eVYXzmbI9e70JpPyfN66cM,string,对应微信官方消息的ToUserName字段
true,device_id,
1702D8OBYWWQ,string,对应微信官方消息的Sn字段，如果为空，则对应Payload.uuid字段
true,model_id,sCxMK3VtUhoBrID5KYGkuQ,string,对应微信官方消息的ModelId字段，如果为空，则对应Payload.model_id

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v2/wx-voip/server/notification' \
--header 'X-Tg-Signed-Headers: x-tg-app-id;x-tg-date' \
--header 'X-Tg-Signed-Headers;' \
--header 'X-Tg-App-Id;' \
--header 'Accept-Language;' \
--header 'Authorization;' \
--header 'X-Tg-Date;' \
--header 'X-Tg-Content-Sha256;' \
--header 'X-Tg-Algorithm;' \
--header 'Content-Length;' \
--header 'Content-Type: application/json' \
--data-raw 'true,action,join_voip_room,string,对应微信官方消息的Action字段
true,payload,eyJ1dWlkIjoiMTcwMkQ4T0JZV1dRIiwiYXBwX2lkIjoid3g5NTE4NWQwYWJlZmQ0YTBlIiwibW9kZWxfaWQiOiJzQ3hNSzNWdFVob0JySUQ1S1lHa3VRIiwiYWN0Ijoiam9pbiJ9,string,对应微信官方消息的Payload字段
true,server_token,Ig0Sojy+PQr6jT3avJpDjweFm9ZFlyQFIiKJLk5tvahcI/gMlbZSrz47Kp/S7I9B/930PKi67Aq+nHArhfXWb/T75CpCzy2dtLp1fxYP1/0=,string,对应微信官方消息的ServerToken字段
true,openid,o7XwO7eVYXzmbI9e70JpPyfN66cM,string,对应微信官方消息的ToUserName字段
true,device_id,
1702D8OBYWWQ,string,对应微信官方消息的Sn字段，如果为空，则对应Payload.uuid字段
true,model_id,sCxMK3VtUhoBrID5KYGkuQ,string,对应微信官方消息的ModelId字段，如果为空，则对应Payload.model_id'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

200表示成功

msg

string

错误描述

必需

示例

{
    "code": 0,
    "msg": "string"
}

🟠400错误

🟠401请登录

🟠403禁止访问

🟠404资源不存在

🔴500服务器内部错误

修改于 2025-03-13 08:47:56