建立訊息 QR Code。
介面說明
-
建立完成 QR Code 後,使用者可使用 WhatsApp 掃描 QR Code 快速開啟對應的商家號碼。
-
在呼叫此介面前,請確保您已有建立成功的 WhatsApp 訊息通道。
-
若您沒有已成功建立的 WhatsApp 訊息通道,可在 通道管理 介面手動建立 WhatsApp 訊息通道。
QPS 限制
本介面的單一使用者 QPS 限制為 5 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cams:CreatePhoneMessageQrdl |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PhoneNumber |
string |
是 |
電話號碼。在 通道管理>管理>WABA 管理>號碼管理介面檢視。 |
86138009**** |
| GenerateQrImage |
string |
是 |
產生圖片類型。類型取值:
枚舉值:
|
PNG |
| PrefilledMessage |
string |
是 |
訊息內容。 |
test |
| CustSpaceId |
string |
否 |
ISV 子客戶的 SpaceId/直客客戶執行個體 ID。在 通道管理 介面檢視 Space ID。 |
cams-kei**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AccessDeniedDetail |
string |
存取被拒絕詳細資訊。 |
|
| RequestId |
string |
請求 ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Message |
string |
錯誤描述資訊。 |
None |
| Data |
object |
返回資料。 |
|
| QrImageUrl |
string |
QR Code 位址。 |
http://img.png |
| PhoneNumber |
string |
號碼。 |
86138009**** |
| QrdlCode |
string |
QR Code 編碼。 |
D9II3*** |
| DeepLinkUrl |
string |
深度連結位址。 |
https://wa.qrdl/ |
| GenerateQrImage |
string |
產生圖片類型。 |
PNG |
| PrefilledMessage |
string |
訊息內容。 |
Hello |
| Code |
string |
錯誤碼。更多詳情請參見錯誤碼。 |
OK |
樣本
正常返回樣本
JSON格式
{
"AccessDeniedDetail": "",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O\n",
"Message": "None",
"Data": {
"QrImageUrl": "http://img.png",
"PhoneNumber": "86138009****",
"QrdlCode": "D9II3***",
"DeepLinkUrl": "https://wa.qrdl/",
"GenerateQrImage": "PNG",
"PrefilledMessage": "Hello"
},
"Code": "OK"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | |
| 400 | System.LimitControl | The system is under flow control. | |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。