Obter modelos.

INTRODUÇÃO

Quando um modelo de mensagem é retornado, a resposta inclui todas as traduções dele(se houver). Os modelos de mensagem são agrupados pelo campo name. Use o parâmetro limit para definir o número de itens retornado.Esse limite se aplica ao número máximo de nomes de modelos de mensagem que podem ser retornados, não ao número máximo de objetos.

OBTER MODELOS

Sintaxe da solicitação

GET api/Templates?name=<NAME>fields=<FIELDS>&limit=<LIMIT>&before=<CURSOR_BEFORE>&after=<CURSOR_AFTER>

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<NAME>Opcional
Filtro para nome do template
beta_pontualofertas3_link_v1_2
<FIELDS>Opcional
Lista de campos de modelos a serem retornados.
null
<LIMIT>Opcional
O número máximo de modelos que você quer que sejam retornados em cada página de resultados.
1
<CURSOR_BEFORE>Opcional
Identificação do cursor de paginação anterior
null
<CURSOR_AFTER>Opcional
Identificação do cursor de paginação posterior
null

Exemplo de solicitação

curl --request GET \
  --url 'https://api-cerberus-kong.socialminer.tech/api/Templates?&name=beta_pontualofertas3_link_v1_2&limit=1' \
  --header 'apikey: {APIKEY}' \
  --header 'version: 6.0'

Resposta

Exemplo de resposta caso a solicitação seja bem-sucedida:

{
    "data": [
        {
            "id": "906291157395288",
            "status": "APPROVED",
            "name": "beta_pontualofertas3_link_v1_2",
            "category": "MARKETING",
            "language": "pt_BR",
            "components": [
                {
                    "type": "BODY",
                    "text": "*Ficou sabendo?* 👀 \n*Antecipamos suas ofertas!*\nEspecialmente pra você! É só inserir o *{{1}}* no site. Vem!"
                },
                {
                    "type": "FOOTER",
                    "text": "Mensagem automática. Digite \"sair\" para se descadastrar."
                },
                {
                    "type": "BUTTONS",
                    "buttons": [
                        {
                            "type": "URL",
                            "text": "Pegar meu presente",
                            "url": "https://beta.socl.me/{{1}}"
                        }
                    ]
                }
            ]
        }
    ],
    "paging": {
        "cursors": {
            "before": "MAZDZD",
            "after": "MAZDZD"
        }
    }
}
Language
Click Try It! to start a request and see the response here!