获取模板

用于获取与业务电话关联的模板列表。

请求参数

名称	类型	描述	必填
Action	string	取值：GetTemplates。	是
AccountId	int	账户 ID。	是
BusinessPhone	string	模板所关联的电话号码。	是
Name	string	模板名称。	否
Limit	int	每次搜索的限制大小。	否
After	string	分页标记。	否
Before	string	分页标记。	否

请求示例

{
    "Action": "GetTemplates",
    "AccountId": 8899,
    "BusinessPhone": "8615xxxx79987",
    "Name":"ceshi",
    "Limit":2,
    "After":"MAZDZD"
}

响应参数

名称	类型	描述
Action	string	GetTemplatesResponse。
RetCode	int	成功为0 错误代码。
Message	string	消息。
RequestId	string	请求标识。
Data	object	返回数据。

Data 参数

名称	类型	描述
Data	[]template	模板列表。
Paging	object	分页信息。

Paging 参数

名称	类型	描述
Cursor	object	分页标记。
Next	string	下一页。如果不为空，可以向前翻页。
Prev	string	上一页。如果不为空，可以向后翻页。

Cursor 参数

名称	类型	描述
After	string	分页游标（下一页）。
Before	string	分页游标（上一页）。

template 参数

名称	类型	描述
ID	string	模板 ID。
Name	string	模板名称。
Category	string	类别。
Language	string	模板语言。
Status	string	状态。
RejectedReason	string	模板被拒绝的原因。
QualityScore	object	模板质量评分。
Tags	[]string	模板标签。
Components	[]component	模板组件。

QualityScore 参数

名称	类型	描述
Score	string	质量评分。

component 参数

参考 组件

返回示例

{
    "Action": "GetTemplatesResponse",
    "Data": {
        "Data": [
            {
                "Category": "AUTHENTICATION",
                "Components": [
                    {
                        "Example": {
                            "BodyText": [
                                [
                                    "1313"
                                ]
                            ]
                        },
                        "Text": "Hi, your verification code is {{1}}, Please do not share the information with others",
                        "Type": "BODY"
                    }
                ],
                "ID": "92962xxxx754",
                "Language": "en",
                "Name": "ceshiyanzhengma",
                "QualityScore": {
                    "Score": "UNKNOWN"
                },
                "Tags": [
                    "TEST_TAG"
                ],
                "RejectedReason": "INVALID_FORMAT",
                "Status": "REJECTED"
            },
            {
                "Category": "UTILITY",
                "Components": [
                    {
                        "Example": {
                            "HeaderHandle": [
                                "https://scontent.whatsapp.net/v/t61.29466-34/339053090_782169319941265_6515992918508567612_n.png?ccb=1-7&_nc_sid=57045b&_nc_ohc=kqoiquC7lvYAX_nBRL_&_nc_ht=scontent.whatsapp.net&edm=AH51TzQEAAAA&oh=01_AdQ6WI1_lWevNio26xXchMxcIv8aeVoF1UD9cTVdXtkkuw&oe=646FF3F7"
                            ]
                        },
                        "Format": "IMAGE",
                        "Type": "HEADER"
                    },
                    {
                        "Text": "TEST TEMPLATE",
                        "Type": "BODY"
                    },
                    {
                        "Buttons": [
                            {
                                "Text": "LINK",
                                "Type": "URL",
                                "URL": "http://uspeedo.com/"
                            }
                        ],
                        "Type": "BUTTONS"
                    }
                ],
                "ID": "782xxxx607932",
                "Language": "af",
                "Name": "ceshi",
                "Tags": null,
                "QualityScore": {
                    "Score": "UNKNOWN"
                },
                "RejectedReason": "INCORRECT_CATEGORY",
                "Status": "REJECTED"
            }
        ],
        "Paging": {
            "Cursors": {
                "After": "MgZDZD",
                "Before": "MQZDZD"
            },
            "Next": "",
            "Previous": ""
        }
    },
    "Message": "",
    "RequestId": "d71eb04c-7475-4f06-8be4-96cea6041545",
    "RetCode": 0
}