Help Center/ Cognitive Engagement Center/ API Reference/ Web Client Access Interface Reference/ Discarding an Email (chat_dropMail)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Discarding an Email (chat_dropMail)

Scenario

This interface is invoked to discard an email.

Method

POST

URI

https://Domain name/apiaccess/rest/ccmessaging/v1/emailchannel/dropMail (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

No

App key, which is the user ID

2

Authorization

String

No

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Request body parameter

No.

Parameter

Type

Mandatory or Not

Description

1.1

emailId

String

Yes

Email ID

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1.1

    returnCode

    String

    Yes

    Return code. The value 0 indicates success. The value 3 indicates that the email ID does not exist.

    1.2

    description

    String

    Yes

    Response description
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

  • Scenario: Discard an email.

    URL: successful request message

    Request header:

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

    Request parameters:

    {
    "emailId":"10195068940994050"
}

    Response parameters:

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