发送服务窗单人消息

说明

调用本接口向指定的用户发送服务窗消息。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	服务窗发送消息权限	API Explorer
第三方企业应用	暂不支持	服务窗发送消息权限	暂不支持
第三方个人应用	暂不支持	服务窗发送消息权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	illegalParameter	Illegal parameter	参数错误
400	idempotentParameterMismatch.uuid	uuid not found.	uuid参数非法。
400	illegalParameter.uuid	illegal uuid.	uuid参数非法。
400	illegalParameter.messageContent	illegal message content.	消息内容不合法。
400	illegalParameter.messageBody	illegal message body.	消息体不合法。
400	illegalParameter.messageType	illegal message type.	消息类型不合法。
400	illegalParameter.messageReceiver	illegal message receiver.	消息接收人不正确。
400	illegalParameter.account	illegal account.	服务窗帐号异常。
400	illegalRequest.overQuota	request over quota.	请求超过配额。
500	systemError	system error.	系统异常。

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

detail

object

消息详情。

必需

msgType

string

消息类型。

必需

uuid

string

必需

消息发送请求唯一ID，长度不超过128位字符。

userId

string

必需

消息接收人的userid。

messageBody

object

消息体。

必需

bizId

string

可选

API调用标识，可不填。

accountId

string

账号id。

可选

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

requestId

string

请求ID。

可选

result

object

返回结果。

可选

openPushId

string

可选

消息推送ID，长度不超过128位，可用于消息发送进度排查。

示例

{
  "requestId": "string",
  "result": {
    "openPushId": "string"
  }
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码