文档首页/ 云客服/ API参考/ 网页客户端接入/ 丢弃邮件(chat_dropMail)
更新时间:2024-09-24 GMT+08:00
分享

丢弃邮件(chat_dropMail)

场景描述

丢弃邮件接口

接口方法

POST

接口URI

https://域名/apiaccess/rest/ccmessaging/v1/emailchannel/dropMail,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

appKey字段,用户标识

2

Authorization

string

False

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

emailId

string

True

email ID

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    说明

    1.1

    returnCode

    string

    返回码。0:成功,3:邮件ID不存在

    1.2

    description

    string

    响应描述

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述:丢弃邮件

    URL:https://域名/apiaccess/rest/ccmessaging/v1/emailchannel/dropMail

    请求头:

    x-app-Key:************************************
    Authorization:Bearer ********************************

    请求参数:

    {
        "emailId":"10195068940994050"
    }

    响应参数:

    {
        "returnCode": "0",
        "description": "dropMail success"
    }

相关文档