wx.h 文件参考

#include "basedef.h"

浏览该文件的源代码.

结构体
struct	WxUser
	Wx VoIP 用户 更多...

类型定义
typedef int(*	TGWXVOIPCALLBACK) (int type, void *data, int len)
	微信voip内部通知回调.

函数
TG_PUBLIC int	wxInit (void)
	注册微信Voip模块.
TG_PUBLIC int	wxGetUsers (struct WxUser **ppWxUser, int *pNUsers)
	获取呼叫对象列表.
TG_PUBLIC void	wxSetCallback (TGWXVOIPCALLBACK cb)
	设置回调.
TG_PUBLIC int	wxCall2 (const char *openid, int timeout)
	呼叫小程序
TG_PUBLIC int	wxCall (const char *openid)
TG_PUBLIC int	wxCancelCall ()
	取消小程序外呼或挂断通话
TG_PUBLIC void	wxUninit (void)
	反初始化wxvoip模块
TG_PUBLIC const char *	wxGetErrStr (int err)

变量
TG_PUBLIC int	_wx_debug

---

结构体说明

WxUser

struct WxUser

Wx VoIP 用户

在文件 wx.h 第 31 行定义.

成员变量
char	openid[48]	用户标识
char	nickname[32]	昵称

类型定义说明

TGWXVOIPCALLBACK

typedef int(* TGWXVOIPCALLBACK) (int type, void *data, int len)

微信voip内部通知回调.

参数

type	类型.见下表
data	type 相关的数据
len	data 指向数据的大小

返回

<0 意味出错. >=0表示正常处理, 具体值看下表

注解

• 获取/更新 sn_ticket. 使用自己的帐号体系的用户才需要实现
  • type = 0
  • data 缓冲区用于返回 sn_ticket 字符串, 包括结尾的 \0
  • len data 指向的缓冲区长度
  • 返回值: 成功时，返回 sn_ticket的长度 + 1，否则返回-1
  • 说明: 如果不是遇到不可恢复错误(例如帐号无效)，该操作应该反复重试直到成功

在文件 wx.h 第 59 行定义.

函数说明

wxInit()

TG_PUBLIC int wxInit

(

void

)

注册微信Voip模块.

在TciStart()前调用

wxGetUsers()

TG_PUBLIC int wxGetUsers	(	struct WxUser **	ppWxUser,
		int *	pNUsers )

获取呼叫对象列表.

参数

ppWxUser	成功时*ppWxUser中返回用户数组指针，调用者要用 free() 释放
pNUsers	成功时*pNUsers返回数组大小

返回

0:成功；其它:错误码定义在 ec_const.h

注解

- 使用带key的uuid，才会返回 nickname

• 使用自己的帐号体系的用户需要使用自己的方式获取呼叫对象，不能调用此接口.

wxSetCallback()

TG_PUBLIC void wxSetCallback

(

TGWXVOIPCALLBACK

cb

)

设置回调.

注解

用于使用自用帐号体系的用户。

wxCall2()

TG_PUBLIC int wxCall2	(	const char *	openid,
		int	timeout )

呼叫小程序

参数

openid	小程序用户标识。
openid	小程序用户标识
timeout	呼叫超时设置，单位:秒. 取值15~60

返回

参看 wx_err.h

注解

呼叫前要通过别的方式获取到设备可以呼叫的用户列表(通讯录)，然后引导操作者
选择(手动, 或通过人脸识别或刷卡等身份识别方式确定操作者绑定的)呼叫对象.