• KB Home
  • SME API
  • SME API: Instant Messengers
  • Getting List of HSM Templates (getOutMessageMatchers)

Getting List of HSM Templates (getOutMessageMatchers)

The method described in this article is only intended for SME.

This method returns a list of HSM templates that were created in edna dashboard.

Request Endpoint

Make a POST request to this URL: https://im.edna.ru/api/getOutMessageMatchers

Request Format and Parameters

The channel and the signature name are passed in the request body. The imType field is required. Subject is an optional field. If you do not specify it, all templates for all signatures will be returned.

{
  "imType": "whatsapp",
  "subject": "test" 
}

Response Format

{
    "id": 4214,
    "name": "4214",
    "imType": "whatsapp",
    "headerType": "DOCUMENT",
    "language": "AU",
    "content": {
        "header": {},
        "text": "This is a test message. {{1}}, {{2}}.",
        "footer": {
            "text": "Signature"
        },
        "keyboard": {
            "row": {
                "buttons": []
            }
        }
    },
    "category": "ACCOUNT_UPDATE",
    "status": "APPROVED",
    "createdAt": "2021-05-25T15:28:57.000+0000",
    "updatedAt": "2021-05-25T15:28:57.000+0000"
}

headerType Format

The header may contain an indication of headerType:

  • TEXT: A text must be passed in the header in the template.
  • IMAGE: An image must be passed in the header in the template.
  • VIDEO: A video must be passed in the header in the template.
  • DOCUMENT : A document must be passed in the header in the template.

If there is no header in the message, headerType is not passed in the response.