Skip to main content

GetSmsDistributionResponse

result objectrequired
idDistributionId (string)

The Distribution ID

Example: EMD_1234567890abcde
namestring
ownerIdOwnerId (string)

The owner of a distribution

Example: UR_1M4aHozEkSxUfCl
organizationIdOrganizationId (string)
Example: exampleorganization1
requestStatusstring
requestTypeRequestType (string)

Possible values: [Invite, ThankYou, Reminder, Email, Portal, PortalInvite, GeneratedInvite]

sendDatestring<date-time>
surveyIdSurveyid (string)

The survey ID associated with the distributions

Example: SV_cHbKMOdeT8NetF3
recipients object
mailingListIdMailingListId (string)

The mailing list or contact group associated with the distribution(s)

Example: CG_012345678901234
contactIdContactId (string)
Example: CGC_012345678901234
libraryIdLibraryId (string)

Library ID of the message

Example: UR_1M4aHozEkSxUfCl
message object
libraryIdLibraryId (string)

Library ID of the message

Example: UR_1M4aHozEkSxUfCl
messageIdMessageId (string)

The ID for the desired library message

Example: MS_0Vdgn7nLGSQBlYN
messageTextMessageText (string)

Text of the message to send

Example: Example Message Text
stats object
sentinteger<int32>

Possible values: >= 0

Default value: 0
failedinteger<int32>

Possible values: >= 0

Default value: 0
startedinteger<int32>

Possible values: >= 0

Default value: 0
finishedinteger<int32>

Possible values: >= 0

Default value: 0
creditsinteger<int32>

Possible values: >= 0

Default value: 0
segmentsinteger<int32>

Possible values: >= 0

Default value: 0
meta objectrequired

Response metadata

httpStatushttp status (string)required

HTTP status code.

requestIdAn identifier of the incoming request. (string)required

Unique identifier of the associated request.

noticeAn informational string about the request. (string)

An informational string about the request.

GetSmsDistributionResponse
{
"result": {
"id": "EMD_1234567890abcde",
"name": "string",
"ownerId": "UR_1M4aHozEkSxUfCl",
"organizationId": "exampleorganization1",
"requestStatus": "string",
"requestType": "Invite",
"sendDate": "2024-07-29T15:51:28.071Z",
"surveyId": "SV_cHbKMOdeT8NetF3",
"recipients": {
"mailingListId": "CG_012345678901234",
"contactId": "CGC_012345678901234",
"libraryId": "UR_1M4aHozEkSxUfCl"
},
"message": {
"libraryId": "UR_1M4aHozEkSxUfCl",
"messageId": "MS_0Vdgn7nLGSQBlYN",
"messageText": "Example Message Text"
},
"stats": {
"sent": 0,
"failed": 0,
"started": 0,
"finished": 0,
"credits": 0,
"segments": 0
}
},
"meta": {
"httpStatus": "string",
"requestId": "string",
"notice": "string"
}
}