Get phone template default by event

Get phone template default by event id and specified language code.

get

Path parameters

eventIdstringRequired

The id of the event.

Query parameters

languageCodestringRequired

The code of the language. The language code must be in the ISO 639-1 format.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/events/{eventId}/phone-templates/default

HTTPcURLJavaScriptPython

GET /api/v1/events/{eventId}/phone-templates/default?languageCode=text HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "languageCode": "en-US",
    "content": "{{product_name}} - Your OTP for secure login is {{otp_code}}. Please do not share this OTP with anyone."
  },
  "errors": []
}