DeleteMessageContact - 删除联系人

删除联系人。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ContactIdstring

联系人 ID。

c-qL4HqKONzOM7****
RetainContactInMembersboolean

是否保留成员中的联系人。取值:

  • true(默认值):保留。保留成员中的此联系人,联系人仍可以接收成员的消息。
  • false:不保留。将此联系人从成员中移除,此联系人不再接收成员的消息。当选择 False 时此接口结果异步返回,您可以通过 GetMessageContactDeletionStatus 获取删除结果。
true

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

9B34724D-54B0-4A51-B34D-4512372FE1BE
Statusstring

联系人删除状态。取值:

  • Deleting:删除中。
  • Deleted:已删除。
Deleting

示例

正常返回示例

JSON格式

{
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Status": "Deleting"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.ContactIdThe ContactId is invalid.ContactId无效。
400MissingParameter.ContactIdYou must specify ContactId.ContactId不能为空。
404EntityNotExists.ContactThis Contact does not exist.Contact不存在。
429ConcurrentCallNotSupportedThe operation conflicts with other operations. Please try again later.当前操作与其他操作冲突,请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:429