添加好友回调

POST

/friend/send

本接口已迁移，请前往小组级接口文档查看（以A区为例）【添加好友回调】

请求参数

Body 参数application/json

code

enum<number>

必需

0 发送成功， 1 搜索不到或搜索失败

枚举值:

data

object

加好友详情

必需

fromwxid

string

托管账号系统联系人id

必需

fromwxName

string

托管账号名称

必需

企微号名称

fromwxAvatar

string

托管账号头像

必需

企微号头像

type

enum<number>

加好友的方式类型

必需

枚举值:

123

phoneNum

string

手机号

可选

type为1时存在

roomWxid

string

系统群聊id

可选

type为2时存在

contactSenderWxid

string

发名片人的系统联系人id

可选

type为3时存在

extraInfo

string

附加信息

必需

payload

object

添加的联系人信息

必需

当code为0时返回

createTimestamp

number

任务创建时间

必需

sendTimestamp

number

好友申请发送时间

必需

message

string

code为1时返回

必需

code为1时返回

token

string

接口调用凭证

必需

errorCode

string

错误码

可选

165搜索好友失败(手机号没注册微信/隐私设置), 166 请求太频繁被限制

示例

{
    "code": 0,
    "data": {
        "fromwxid": "string",
        "fromwxName": "string",
        "fromwxAvatar": "string",
        "type": 1,
        "phoneNum": "string",
        "roomWxid": "string",
        "contactSenderWxid": "string",
        "extraInfo": "string",
        "payload": {
            "avatar": "string",
            "name": "string",
            "gender": 0,
            "wxid": "string",
            "friend": true
        },
        "createTimestamp": 0,
        "sendTimestamp": 0,
        "message": "string",
        "token": "string",
        "errorCode": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/friend/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": 0,
    "data": {
        "fromwxid": "string",
        "fromwxName": "string",
        "fromwxAvatar": "string",
        "type": 1,
        "phoneNum": "string",
        "roomWxid": "string",
        "contactSenderWxid": "string",
        "extraInfo": "string",
        "payload": {
            "avatar": "string",
            "name": "string",
            "gender": 0,
            "wxid": "string",
            "friend": true
        },
        "createTimestamp": 0,
        "sendTimestamp": 0,
        "message": "string",
        "token": "string",
        "errorCode": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

修改于 2024-10-24 10:50:25

通过手机号加好友接口

好友通过后回调