forked from nxtele/http-api-document
-
Notifications
You must be signed in to change notification settings - Fork 1
WhatsApp API deleteMedia
CodingMakeWordBetter edited this page Oct 17, 2022
·
8 revisions
Delete file information that has been uploaded to WhatsApp via API
- URL:
https://api2.nxcloud.com/api/wa/deleteMedia - Method:
POST - Content-Type:
applicatin/json - Authentication required:
yes
For authentication rules, please refer to the address:API interface calling convention
| **parameter ** | type | required | example value | illustrate |
|---|---|---|---|---|
| accessKey | String | Yes | fme2na3kdi3ki | User ID |
| ts | String | Yes | 1655710885431 | The timestamp of the current request (unit is milliseconds), the Niuxin server allows the client to request a maximum time error of 60 seconds |
| bizType | String | Yes | 2 | WhatsApp business type, fixed value "2" |
| action | String | Yes | deleteMedia | WhatsApp business operation, take the fixed value "deleteMedia" |
| sign | String | Yes | 6e9506557d1f289501d333ee2c365826 | API input parameter signature,,signature algorithm |
| parameter | type | required | example | illustrate |
|---|---|---|---|---|
| business_phone | String | Yes | 86158xxxx1795 | Merchant mobile phone number with country code. Such as 86158xxxx1795 |
| messaging_product | String | Yes | The channel for sending messages, when applied to the sending of WhatsApp messages, the value must be "whatsapp" | |
| Media-ID | String | Yes | fd81acff-eea8-4d9d-acc9-6c62904d6615 | Media file ID |
body(application/json) parameters:
{
"business_phone": "86158xxxx1795",
"Media-ID": "fd81acff-eea8-4d9d-acc9-6c62904d6615",
"messaging_product": "whatsapp"
}| parameter | type | illustrate |
|---|---|---|
| code | Integer | result encoding |
| data | JsonObject | request result |
| message | String | Description of request result |
- data object parameter:
| parameter | type | illustrate |
|---|---|---|
| success | boolean | success sign |
{
"code": 0,
"data": {
"success": true,
},
"message": "请求成功"
}{
"code": -1,
"message": "请求失败",
"data": null
}| code | message | Solution |
|---|---|---|
| 0 | request succeeded | |
| -1 | Request failed | Please contact a technician to troubleshoot the problem |
| 1000~100X | Authentication problem | For details, see the API Authentication section |
| 9000 | parameter exception | Missing parameters, please check the required parameters |
| 9001 | System business error | Please contact a technician to troubleshoot the problem |
| 9002 | Merchant phone number is wrong | Please confirm if the merchant number is a whatsapp number |
| 9006 | The whatsapp number is not bound to the app | Please contact the sales staff to handle the application and mobile phone number binding operation |
Introduction
- Send Message
- Mark Incoming Message as Read
- Upload Media File
- Get Media File
- Delete Media File
- Webhook
- Query Number Information
- Query Message Template
- Create Message Template
- Edit Message Template
- Delete Message Template
- Upload Template Example File
- Embedded Page Login
- Create Client Application
- List of Phone Numbers for Client Application
- Get Verification Code
- Verify Verification Code
- Create Local Client
Short message
Voice
Call Center(NXLink)
- Web Iframe
- Manual Dial Record
- Manual Dial Record Query By orderId
- List Agent Information
- List Agent Status
- List Queue
- List Agents In Queue
- List Agent Efficiency
- Update Queue Agents
- Create AutoDial Task
- Webhook - Manual Dial
AI Agent(NXLink)
- AI Agent Task List
- Query Call Records
- Append Contacts to an Existing Task
- Delete Contacts
- Call Record Callback
Call Center(Callbot)
- Callbot API Summary
- Callbot API Authorization
- Callbot API Ping
- Create Auto Dial Task
- Add Contact List To Task
- Create Task And Add Contact
- Start Or Pause Task
- Update Task Parameters
- Get List Task
- List Call
- List Task Orders
- Stop Order
- Get Call Detail By Order
- Webhook - By Call
- Webhook - By Order
- Webhook - Task Status
Flash Call
Short links
邮件验证码
DID号码
通用
号码检测