发私信给用户

Scope: enterprise.im 需要申请权限 需要用户授权 该接口用于主动发送私信至抖音用户(暂不支持群聊),支持文本、图片(需上传至素材库)、视频消息(需是审核通过的抖音视频 id)和企业消息卡片。可结合客服管理接口,提升客服场景体验。

注意:使用该能力,需要授权的抖音用户是企业号

企业号与用户非为互相关注状态,用户无主动咨询,企业号可给同一用户主动发消息数不超过 3 条,1 小时最多发送 40 个用户,1 天最多发送 100 个用户;消息将展示在用户私信列表的【陌生人列表】处。自动回复消息,不计入 3 条可发送消息的额度中。

用户向企业号主动发送一条消息后,企业号可在 48 小时内向用户发送 6 条消息。

企业号向双关用户(企业号与用户为互相关注状态)发送消息无条数、频次限制。

当前能力内测名额已满,已暂停申请。

具体私信消息类型见下方 Schema:

text
{
  text: string  //文字内容
}

image
{
  media_id: string //素材id
}

video
{
  item_id: string //视频id
}

card
{
  card_id: string //卡片id
}

请求地址

POST /enterprise/im/message/send/

请求头

  • Content-Type: application/json
  • access-token: 调用/oauth/access_token/生成的 token,此 token 需要用户授权。示例: act.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27L56lr

请求参数

URL 请求

参数名称参数类型参数描述参数示例是否必填
暂无数据

Body 请求

参数名称参数类型参数描述参数示例是否必填
暂无数据

响应参数

参数名称参数类型参数描述参数示例是否必填
暂无数据

响应样例

{
  "data": {
    "description": "",
    "error_code": "0",
    "server_msg_id": "<nil>"
  },
  "extra": {
    "description": "",
    "error_code": "0",
    "logid": "202008121419360101980821035705926A",
    "now": "1597213176393",
    "sub_description": "",
    "sub_error_code": "0"
  }
}

响应错误样例

{
  "data": {
    "description": "Parameter error",
    "error_code": 2100005
  },
  "extra": {
    "logid": "2020070614111601022506808001045D59",
    "now": 1594015876138
  }
}
诚邀您对本文档易读易用性进行评价
好用
不好用