sms-notifications
Operations addressed under /sms-notifications — 13 operations.
get-sms-notification-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<SmsNotificationDto>.
| Field | Declared type | Nullable |
|---|---|---|
Severity | int | no |
Correlationid | Guid? | yes |
NotifyDateTime | DateTime? | yes |
Status | int | no |
SmsNotificationGroupId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-sms-notification-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-sms-notification
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_27 | 400 | SMS_NOTIFICATION_GROUP_NOT_FOUND_WITH_ID | SmsNotificationGroup not found with given id. Id: {0} |
create-sms-notification › Request Body
correlationIdseverityPermitted values — validated against the severity parameter.
| Value | Meaning |
|---|---|
1 | OTP |
2 | Transaction |
3 | Marketting |
Permitted values — validated against the severity parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | OTP | ar: رمز التحقق لمرة واحدة |
2 | Transaction | ar: عملية |
3 | Marketting | ar: التسويق |
statusPermitted values — validated against the notification_status parameter.
| Value | Meaning |
|---|---|
1 | Waiting |
2 | Success |
3 | Error |
Permitted values — validated against the notification_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Waiting | ar: نجاح |
2 | Success | ar: خطأ |
3 | Error | no label seeded |
bulkNotificationIdnotifyDateTimesmsNotificationGroupIdcreate-sms-notification › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-sms-notification-by-priority
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
get-sms-notification-by-priority › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
notifyDateTimesmsNotificationIdget-sms-notification-scheduled-detail-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<SmsNotificationDetailDto>.
| Field | Declared type | Nullable |
|---|---|---|
NotifyDate | DateOnly | no |
SmsNotificationId | Guid? | yes |
TemplateDesignId | Guid? | yes |
NotificationType | int | no |
LanguageCode | string | no |
SmsTo | string | no |
SmsBody | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
query Parameters
pageIndexpageSizeget-sms-notification-scheduled-detail-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
idlanguageCodenotificationTypePermitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Broadcast | en: Broadcast · ar: البث |
2 | Personalized | en: Personalized · ar: مُخصص |
notifyDatesmsBodysmsNotificationIdsmsTotemplateDesignIdsend-bulk-sms-notifications
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
send-bulk-sms-notifications › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-sms-notification-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as SmsNotificationDto.
| Field | Declared type | Nullable |
|---|---|---|
Severity | int | no |
Correlationid | Guid? | yes |
NotifyDateTime | DateTime? | yes |
Status | int | no |
SmsNotificationGroupId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
path Parameters
idget-sms-notification-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-sms-notification
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
ERR_NTFC_27 | 400 | SMS_NOTIFICATION_GROUP_NOT_FOUND_WITH_ID | SmsNotificationGroup not found with given id. Id: {0} |
path Parameters
idupdate-sms-notification › Request Body
correlationIdnotifyDateTimeseverityPermitted values — validated against the severity parameter.
| Value | Meaning |
|---|---|
1 | OTP |
2 | Transaction |
3 | Marketting |
Permitted values — validated against the severity parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | OTP | ar: رمز التحقق لمرة واحدة |
2 | Transaction | ar: عملية |
3 | Marketting | ar: التسويق |
statusPermitted values — validated against the notification_status parameter.
| Value | Meaning |
|---|---|
1 | Waiting |
2 | Success |
3 | Error |
Permitted values — validated against the notification_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Waiting | ar: نجاح |
2 | Success | ar: خطأ |
3 | Error | no label seeded |
smsNotificationGroupIdupdate-sms-notification › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
create-sms-notification-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_12 | 400 | LANGUAGE_CODE_NOT_FOUND | Language code cannot be found. |
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
path Parameters
idcreate-sms-notification-detail › Request Body
notificationTypePermitted values — validated against the notification_type parameter.
| Value | Meaning |
|---|---|
1 | Broadcast |
2 | Personalized |
Permitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Broadcast | en: Broadcast · ar: البث |
2 | Personalized | en: Personalized · ar: مُخصص |
smsBodysmsTolanguageCodenotifyDatetemplateDesignIdcreate-sms-notification-detail › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
delete-sms-notification
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
path Parameters
iddelete-sms-notification › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-sms-notification-detail-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as SmsNotificationDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
NotifyDate | DateOnly | no |
SmsNotificationId | Guid? | yes |
TemplateDesignId | Guid? | yes |
NotificationType | int | no |
LanguageCode | string | no |
SmsTo | string | no |
SmsBody | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
ERR_NTFC_4 | 400 | SMS_NOTIFICATION_DETAIL_NOT_FOUND | SMS notification detail cannot be found. |
path Parameters
idsmsNotificationDetailIdget-sms-notification-detail-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-sms-notification-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_12 | 400 | LANGUAGE_CODE_NOT_FOUND | Language code cannot be found. |
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
ERR_NTFC_4 | 400 | SMS_NOTIFICATION_DETAIL_NOT_FOUND | SMS notification detail cannot be found. |
path Parameters
idsmsNotificationDetailIdupdate-sms-notification-detail › Request Body
languageCodenotificationTypePermitted values — validated against the notification_type parameter.
| Value | Meaning |
|---|---|
1 | Broadcast |
2 | Personalized |
Permitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Broadcast | en: Broadcast · ar: البث |
2 | Personalized | en: Personalized · ar: مُخصص |
notifyDatesmsBodysmsTotemplateDesignIdupdate-sms-notification-detail › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-sms-notification-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
ERR_NTFC_4 | 400 | SMS_NOTIFICATION_DETAIL_NOT_FOUND | SMS notification detail cannot be found. |
path Parameters
idsmsNotificationDetailIddelete-sms-notification-detail › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update-sms-notification-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_2 | 400 | SMS_NOTIFICATION_NOT_FOUND | SMS notification cannot be found. |
path Parameters
idupdate-sms-notification-status › Request Body
statusPermitted values — validated against the notification_status parameter.
| Value | Meaning |
|---|---|
1 | Waiting |
2 | Success |
3 | Error |
Permitted values — validated against the notification_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Waiting | ar: نجاح |
2 | Success | ar: خطأ |
3 | Error | no label seeded |
update-sms-notification-status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.