Retrieve SMS campaign for an administrator
This endpoint retrieves the details of an SMS campaign associated with a specific administrator identified by the TPA ID. It is useful for administrators to monitor and manage their SMS communication campaigns effectively.
Request
-
tpaId string Required
A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.
Response
-
CampaignId string
The SMS campaign ID, generated when the campaign was created.
-
AdministratorId string
The ID of the administrator associated with this campaign.
-
Name string
The name of this SMS campaign.
-
PhoneNumber string
The toll free number provisioned for this SMS campaign where outbound SMS messages are sent from.
-
Status string
The status of this campaign. Valid statuses are Pending or Active.
-
PreConversionNotificationDate string <date-time>
The date a preconversion message for SMS gateway conversion was sent for this campaign.
-
PostConversionNotificationDate string <date-time>
The date a postconversion message for SMS gateway conversion was sent for this campaign.
-
Gateway string
The SMS gateway currently serving this campaign.
-
DateCreated string <date-time>
The date this campaign was created.
-
DateUpdated string <date-time>
The date this campaign was most recently updated.