Skip to main content

Retrieve A Sms Notifier Pattern

Retrieve a specific sms notifier pattern details

HTTP Request

GET/api/notifications/notifiers/sms notifiers/:notifier_id/patterns/:id

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with SMSPatternPermission or Admin
  • Permission Code: 2822
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

ParameterTypeRequiredDescription
notifier_idIntegerYesUnique ID of the sms notifier
idIntegerYesUnique ID of the sms pattern

Example Requests

1import requests
2response = requests.get('http://www.example.com/api/notifications/notifiers/sms/1/patterns/4', headers={
3  'Authorization': 'Token <your_api_key>'
4})
5
6print(response.json())

Response Fields

FieldTypeDescription
idIntegerUnique ID of the sms pattern.
statusStringStatus of the sms pattern (choices: `created`, `pending`, `approved`, `rejected`)
nameStringName of the sms pattern
codeStringCode of the sms pattern
descriptionStringExtra descriptions about the sms pattern (nullable)
bodyStringText body of the sms pattern
created_atString (ISO 8601)Timestamp when the sms pattern was created.
updated_atString (ISO 8601)Timestamp when the sms pattern] was last updated.

Response Example

{
"id": 3,
"status": "rejected",
"name": "otp-code",
"code": "187566",
"description": "used for sending otp codes",
"body": "Your login otp code is {0}",
"created_at": "2025-12-28T16:42:35.264559Z",
"updated_at": "2025-12-28T16:42:35.264568Z"
}