GET api/v1/admin/templates

Lists all the message templates on the account.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of all message templates.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateResponse

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "ID": "b8881dfc-2f15-4168-8462-20fd44ef3ba8",
        "Enabled": true,
        "Name": "sample string 3",
        "Template": "sample string 4",
        "Type": 1
      },
      {
        "ID": "b8881dfc-2f15-4168-8462-20fd44ef3ba8",
        "Enabled": true,
        "Name": "sample string 3",
        "Template": "sample string 4",
        "Type": 1
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfMessageTemplateResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <MessageTemplateResponse>
        <Name>sample string 3</Name>
        <Template>sample string 4</Template>
        <Type>ALL</Type>
        <ID>b8881dfc-2f15-4168-8462-20fd44ef3ba8</ID>
        <Enabled>true</Enabled>
      </MessageTemplateResponse>
      <MessageTemplateResponse>
        <Name>sample string 3</Name>
        <Template>sample string 4</Template>
        <Type>ALL</Type>
        <ID>b8881dfc-2f15-4168-8462-20fd44ef3ba8</ID>
        <Enabled>true</Enabled>
      </MessageTemplateResponse>
    </Detail>
  </ResponseData>
</ResponseOfListOfMessageTemplateResponse>