VEvetcove
Inbox

Fetch an SMS notification

Retrieves an SMS notification by its ID.

An SMS notification represents a text message sent to a clinic client's primary phone number on behalf of a clinic via the API.

Only SMS notifications initiated through the API are included in this resource. Transactional notifications sent automatically by Vetcove (e.g. order confirmations, appointment reminders) are not returned.

get/ext/v2/sms-notifications/{sms_notification_id}/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/sms-notifications/{sms_notification_id}/
  • Auth
    HTTP bearer

Path parameters

sms_notification_idinteger required

Response

OK

bodystring required

The SMS message body.

client_communication_number_idinteger required

The ID of the client communication number the SMS was sent to.

clinic_client_idinteger required

The ID of the clinic client the SMS was sent to.

clinic_idinteger required

The ID of the clinic the SMS was sent from.

created_atstring date-time required

When the SMS notification was created.

error_codestring nullable required

Error code from the SMS provider if sending failed.

error_reasonstring nullable required

Human-readable reason for the error, if the error code is recognized.

idinteger required

The ID of the SMS notification.

status'SENT' | 'DELIVERED' | 'FAILED_TO_SEND' required

Delivery status of an SMS notification sent via the Connect API.

Changes

No recorded changes to this operation across all 1 revision of this API.