Tech231 Platform SMS API
string · uuid · requiredenum · requirednull | string · requiredboolean · requiredinteger | string · int32 · pattern: boolean · requiredinteger | string · int32 · pattern: booleanstringinteger | string · int32 · pattern: integer | string · int32 · pattern: string[]string · minLength: 10 · maxLength: 20 · requiredstring · minLength: 1 · maxLength: 1600 · requiredstring · minLength: 1 · maxLength: 50 · requiredstring[] · minItems: 1 · requiredstring · minLength: 1 · maxLength: 1600 · requiredstring · minLength: 1 · maxLength: 13 · requiredstringinteger | string · int32 · pattern: string[]string · date-timeenumstringstringstringstringenumnull | stringstring · date-timenull | string · date-timenull | string · date-timenull | stringinteger | string · int32 · pattern: string · uuidstringnull | stringenumstringinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: string · date-timenull | string · date-timenull | string · date-timenull | string · date-timestring · uuidstringstringstringenumstring · date-timenull | string · date-timenull | string · date-timenull | string · date-timeinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: stringstring · uuidstringnull | stringnull | stringenumstring · date-timenull | string · date-timenull | string · date-timenull | string · date-timeinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: booleanbooleanstring · requiredstring · requiredstring · uuidnull | stringnull | stringnull | stringnull | stringstring[]integerstring · date-timestring · date-timenull | stringnull | stringnull | stringnull | stringnull | string · minLength: 0 · maxLength: 200null | arraynull | string · minLength: 0 · maxLength: 200integer | string · int32 · min: 1 · max: 2147483647 · pattern: integer | string · int32 · min: 1 · max: 1000 · pattern: null | string · pattern: string · pattern: string · uuidstringstringnull | stringstring[]string · date-timestringinteger | string · int32 · pattern: booleaninteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: string · uuidstring · date-timeobjectinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: string · date-timestring · minLength: 1 · maxLength: 100 · requirednull | string · minLength: 0 · maxLength: 500null | integer | string · int32 · pattern: string · pattern: null | string · minLength: 0 · maxLength: 100null | string · minLength: 0 · maxLength: 100null | string · minLength: 0 · maxLength: 255null | string · minLength: 0 · maxLength: 200string[]integerstring · minLength: 0 · maxLength: 100 · requirednull | string · minLength: 0 · maxLength: 500string[]string · requiredstring · requiredenum · requiredstring · requirednull | string · requiredstring · requirednull | string · requirednull | string · requirednull | stringnull | stringnull | stringnull | arraystring · date · requiredstring · requiredinteger | string · int64 · pattern: integer | string · int64 · pattern: integer | string · int64 · pattern: integer | string · int64 · pattern: null | number | string · double · pattern: null | number | string · double · pattern: string · requiredstring · date · requiredstring · date · requiredinteger | string · int32 · pattern: string · requiredenumnull | string · minLength: 0 · maxLength: 100null | string · minLength: 3 · maxLength: 11null | integer | string · int32 · min: 1 · max: 60 · pattern: null | integer | string · int32 · min: 4 · max: 8 · pattern: null | stringstringstringintegerstring · date-timestringnull | string · date-timenull | string · date-timeinteger | string · int64 · pattern: booleannull | stringintegerstring · date-timenull | string · date-timenull | stringstring · uuidstringnull | stringnull | stringenumstring · date-timenull | string · date-timenull | string · date-timenull | string · date-timeinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: booleanbooleanstring · uuidstringstringnull | stringstring[]string · date-timestringinteger | string · int32 · pattern: string · uuidstringnull | stringnull | stringnull | stringnull | stringstring[]integerstring · date-timestring · date-timenull | stringnull | stringstringenumenumnull | stringnull | stringnull | string · date-timenull | string · date-timeinteger | string · int64 · pattern: booleanstring · uuidstringenumstring · date-timeenumbooleanenumnull | stringnull | string · uuidnull | stringnull | stringnull | integer | string · int32 · pattern: null | stringnull | stringstringstringstringnull | stringnull | stringstring · date-timestringstring · requiredstring · requiredstring · minLength: 3 · maxLength: 11 · requirednull | string · uuidstring · requiredenum · requiredstring · requirednull | stringstringnull | stringnull | integer | string · int32 · pattern: booleannull | stringenumstring · date-timenull | stringstringenumenumnull | stringnull | stringnull | stringstring · date-timenull | string · date-timenull | string · date-timenull | string · date-timeinteger | string · int64 · pattern: null | stringnull | stringnull | stringnull | stringstring · date-timeenumstringnull | stringnull | stringnull | string · minLength: 0 · maxLength: 200null | string · minLength: 0 · maxLength: 200null | string · minLength: 0 · maxLength: 20null | string · minLength: 0 · maxLength: 100null | string · minLength: 0 · maxLength: 3null | string · minLength: 0 · maxLength: 50null | string · minLength: 0 · maxLength: 20null | string · date-timeinteger | string · int32 · min: 1 · max: 100 · pattern: null | arraystringenumenumnull | stringnull | stringnull | string · date-timenull | string · date-timeinteger | string · int64 · pattern: booleanstringinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: number | string · double · pattern: integer | string · int64 · pattern: null | stringinteger | string · int64 · pattern: string · date-timeinteger | string · int64 · pattern: integer | string · int64 · pattern: integer | string · int64 · pattern: integer | string · int64 · pattern: number | string · double · pattern: number | string · double · pattern: number | string · double · pattern: integer | string · int64 · pattern: number | string · double · pattern: number | string · double · pattern: null | stringnull | integer | string · int32 · pattern: stringstringstring · uuidstringstringstringstringenumnull | stringstring[]string · date-timenull | string · date-timenull | string · date-timenull | string · date-timenull | string · date-timenull | string · date-timenull | stringnull | stringinteger | string · int32 · pattern: null | stringnull | string · uuidnull | stringenumstring · date-timeenumstringinteger | string · int32 · pattern: null | stringstring · uuidstringstringstringenumstring · date-timenull | string · date-timenull | string · date-timenull | string · date-timenull | stringnull | stringnull | string · uuidstring · requiredstring · requiredstring · requiredboolean · requiredboolean · requirednull | string · requiredstring · requirednull | string · requirednull | string · requirednull | array · requirednull | array · requiredstring · date-time · requirednull | string · date-time · requiredinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int64 · pattern: null | stringnull | string · date-timenull | string · pattern: null | string · minLength: 0 · maxLength: 100null | string · minLength: 0 · maxLength: 100null | string · minLength: 0 · maxLength: 255null | string · minLength: 0 · maxLength: 200null | arrayenum · requiredstring · requiredboolean · requirednull | string · requiredstring · requirednull | string · requiredboolean · requirednull | string · requirednull | stringnull | stringnull | stringnull | arraynull | array
<>f__AnonymousType21OfGuidAndMessageBatchStatusAndString
batchIdstatusEnum values:
Open
Processing
Failed
Success
CompletedWithErrors
Scheduled
Canceled
message<>f__AnonymousType23OfBooleanAndInt32
successaddedCount^-?(?:0|[1-9]\d*)$ · required<>f__AnonymousType24OfBooleanAndInt32
successremovedCount^-?(?:0|[1-9]\d*)$ · requiredAddBroadcastMessageResponse
successbatchIdqueuedCount^-?(?:0|[1-9]\d*)$totalRecipients^-?(?:0|[1-9]\d*)$messageIdsAddMessageToBatchRequest
recipientcontentsenderIdnull | object
AddMessagesRequest
receiverscontentsenderIdobject
AddMessagesResponse
batchIdtotalAdded^-?(?:0|[1-9]\d*)$messageIdsBatchHistoryEntry
timestampstatusEnum values:
Open
Processing
Failed
Success
CompletedWithErrors
Scheduled
Canceled
notesBatchMessageStatusResponse
messageIdrecipientcontentstatusEnum values:
New
Queued
Sending
Sent
Failed
Delivered
Received
PartialReceived
failureReasoncreatedAtsentAtdeliveredAtnull | object
BatchMessageStatusesResponse
object[]
nextPageTokentotalCount^-?(?:0|[1-9]\d*)$BatchResponse
batchIdnamedescriptionstatusEnum values:
Open
Processing
Failed
Success
CompletedWithErrors
Scheduled
Canceled
senderIdtotalMessages^-?(?:0|[1-9]\d*)$pendingCount^-?(?:0|[1-9]\d*)$successCount^-?(?:0|[1-9]\d*)$failureCount^-?(?:0|[1-9]\d*)$createdAtstartedAtscheduledAtcompletedAtnull | object
BatchStatus
batchIdtenantIdnamedescriptionstatusEnum values:
Open
Processing
Failed
Success
CompletedWithErrors
Scheduled
Canceled
createdAtstartedAtcompletedAtscheduledTimetotalMessages^-?(?:0|[1-9]\d*)$successCount^-?(?:0|[1-9]\d*)$failureCount^-?(?:0|[1-9]\d*)$pendingCount^-?(?:0|[1-9]\d*)$maxConcurrency^-?(?:0|[1-9]\d*)$errorMessageobject[]
BatchSummary
batchIdtenantIdnamedescriptionstatusEnum values:
Open
Processing
Failed
Success
CompletedWithErrors
Scheduled
Canceled
createdAtstartedAtcompletedAtscheduledTimetotalMessages^-?(?:0|[1-9]\d*)$successCount^-?(?:0|[1-9]\d*)$failureCount^-?(?:0|[1-9]\d*)$pendingCount^-?(?:0|[1-9]\d*)$maxConcurrency^-?(?:0|[1-9]\d*)$isCompletedhasFailuresContact
tenantIdphoneNumberidfirstNamelastNameemailcompanytagsobject
statuscreatedAtupdatedAtcreatedByUserIdupdatedByUserIdfullNamedisplayNameContactFilterDto
search
tagscompanypage^-?(?:0|[1-9]\d*)$pageSize^-?(?:0|[1-9]\d*)$sortBy^(firstname|lastname…sortDirection^(asc|desc)$ContactGroup
idtenantIdnamedescriptioncontactIdscreatedAtcreatedByUserIdcontactCount^-?(?:0|[1-9]\d*)$ContactImportResult
successtotalProcessed^-?(?:0|[1-9]\d*)$successfullyImported^-?(?:0|[1-9]\d*)$skipped^-?(?:0|[1-9]\d*)$failed^-?(?:0|[1-9]\d*)$object[]
importIdcompletedAtmetadataContactStats
totalContacts^-?(?:0|[1-9]\d*)$activeContacts^-?(?:0|[1-9]\d*)$inactiveContacts^-?(?:0|[1-9]\d*)$optedOutContacts^-?(?:0|[1-9]\d*)$blockedContacts^-?(?:0|[1-9]\d*)$pendingVerificationContacts^-?(?:0|[1-9]\d*)$totalGroups^-?(?:0|[1-9]\d*)$recentContacts^-?(?:0|[1-9]\d*)$generatedAtCreateBatchRequest
namedescriptionmaxConcurrency^-?(?:0|[1-9]\d*)$CreateContactDto
phoneNumber^\+[1-9]\d{1,14}$ · requiredfirstNamelastNameemailcompanytagsobject
statusCreateContactGroupDto
namedescriptioncontactIdsCreateRuleRequest
shortcodekeywordactionTypeEnum values:
Webhook
GrainForward
targetsecretCreateStatusWebhookRequest
urlsecretnamehttpMethodDefault: POST
bodyTemplatequeryParamTemplatenull | object
sourceIpFiltersDailySmsAnalyticsDto
dateUtctenantIdsentCount^-?(?:0|[1-9]\d*)$ · requireddeliveredCount^-?(?:0|[1-9]\d*)$ · requiredfailedCount^-?(?:0|[1-9]\d*)$ · requiredinboundCount^-?(?:0|[1-9]\d*)$ · requireddeliveryRatePercent^-?(?:0|[1-9]\d*)(?:…failureRatePercent^-?(?:0|[1-9]\d*)(?:…DailySmsAnalyticsResponse
tenantIdstartDateendDateobject[] · required
count^-?(?:0|[1-9]\d*)$GenerateOtpCommand
phoneNumberpurposeEnum values:
Login
PasswordReset
TransactionVerification
AccountActivation
Custom
customMessageTemplatesenderIdexpiryMinutes^-?(?:0|[1-9]\d*)$codeLength^-?(?:0|[1-9]\d*)$metadataKeywordAllocationDto
keywordtenantIdstatusallocatedAtallocatedByUserIdexpiresAtlastUsedAtusageCount^-?(?:0|[1-9]\d*)$object
KeywordAllocationResultDto
successerrorMessagestatusallocatedAtexpiresAtallocationIdListOfBatchSummary
object[]
batchIdtenantIdnamedescriptionstatusEnum values:
Open
Processing
Failed
Success
CompletedWithErrors
Scheduled
Canceled
createdAtstartedAtcompletedAtscheduledTimetotalMessages^-?(?:0|[1-9]\d*)$successCount^-?(?:0|[1-9]\d*)$failureCount^-?(?:0|[1-9]\d*)$pendingCount^-?(?:0|[1-9]\d*)$maxConcurrency^-?(?:0|[1-9]\d*)$isCompletedhasFailuresListOfContactGroup
object[]
idtenantIdnamedescriptioncontactIdscreatedAtcreatedByUserIdcontactCount^-?(?:0|[1-9]\d*)$ListOfContactSummary
object[]
idphoneNumberfirstNamelastNameemailcompanytagsstatuscreatedAtupdatedAtfullNamedisplayNameListOfSenderIdSummary
object[]
senderIdtypeEnum values:
Alphanumeric
Shortcode
SharedShortcode
statusEnum values:
PendingApproval
Approved
Rejected
Suspended
Expired
Released
tenantIdkeywordexpiresAtlastUsedAtusageCount^-?(?:0|[1-9]\d*)$isExpiredOtpGenerationResult
otpRequestIdphoneNumberpurposeEnum values:
Login
PasswordReset
TransactionVerification
AccountActivation
Custom
expiresAtstatusEnum values:
Pending
Verified
Expired
Cancelled
MaxAttemptsExceeded
OtpVerificationResult
isValidstatusEnum values:
Pending
Verified
Expired
Cancelled
MaxAttemptsExceeded
messageotpRequestIdProblemDetails
typetitlestatus^-?(?:0|[1-9]\d*)$detailinstanceRegulatoryDocument
idnamedocumentTypefileUrlfileHashuploadedAtuploadedByUserIdSendSmsCommand
recipientThe Reciever of the Messages Formatted as 231[PhoneNumber]
messageThe SMS Message to Send
senderThe Sender Number or Name
batchIdSenderIdAllocationRequest
requestedByUserIdtypeEnum values:
Alphanumeric
Shortcode
SharedShortcode
businessJustificationkeywordsenderIdintendedUseCaseexpectedMonthlyVolume^-?(?:0|[1-9]\d*)$object[]
SenderIdAllocationResponseDto
successerrorMessagestatusEnum values:
PendingApproval
Approved
Rejected
Suspended
Expired
Released
requestedAtallocationIdSenderIdDetailsDto
senderIdtypeEnum values:
Alphanumeric
Shortcode
SharedShortcode
statusEnum values:
PendingApproval
Approved
Rejected
Suspended
Expired
Released
tenantIdrequestedByUserIdapprovedByUserIdrequestedAtapprovedAtexpiresAtlastUsedAtusageCount^-?(?:0|[1-9]\d*)$object[]
object
object[]
keywordnotesrequestedOnBehalfOfByrequestedByAdminOrgIdSenderIdHistoryEntryDto
timestampstatusEnum values:
PendingApproval
Approved
Rejected
Suspended
Expired
Released
actionuserIdnotesSenderIdMetadataDto
companyNamecontactEmailcontactPhoneindustrycountryobject
SenderIdSearchRequestDto
patternkeywordminExpiryDatemaxResults^-?(?:0|[1-9]\d*)$statusFilterEnum values:
PendingApproval
Approved
Rejected
Suspended
Expired
Released
SenderIdSummary
senderIdtypeEnum values:
Alphanumeric
Shortcode
SharedShortcode
statusEnum values:
PendingApproval
Approved
Rejected
Suspended
Expired
Released
tenantIdkeywordexpiresAtlastUsedAtusageCount^-?(?:0|[1-9]\d*)$isExpiredShortcodePoolStatsDto
shortcodetotalAllocated^-?(?:0|[1-9]\d*)$activeAllocations^-?(?:0|[1-9]\d*)$reservedCount^-?(?:0|[1-9]\d*)$expiredCount^-?(?:0|[1-9]\d*)$maxKeywords^-?(?:0|[1-9]\d*)$availableSlots^-?(?:0|[1-9]\d*)$utilizationPercentage^-?(?:0|[1-9]\d*)(?:…totalUsage^-?(?:0|[1-9]\d*)$mostActiveKeywordmostActiveKeywordUsage^-?(?:0|[1-9]\d*)$object
calculatedAtSmsAnalyticsOverviewDto
totalMessages^-?(?:0|[1-9]\d*)$deliveredMessages^-?(?:0|[1-9]\d*)$failedMessages^-?(?:0|[1-9]\d*)$pendingMessages^-?(?:0|[1-9]\d*)$deliveryRate^-?(?:0|[1-9]\d*)(?:…failureRate^-?(?:0|[1-9]\d*)(?:…avgDeliveryTime^-?(?:0|[1-9]\d*)(?:…uniqueRecipients^-?(?:0|[1-9]\d*)$totalCost^-?(?:0|[1-9]\d*)(?:…costPerMessage^-?(?:0|[1-9]\d*)(?:…topSenderIdpeakHour^-?(?:0|[1-9]\d*)$reportGeneratedAtreportPeriodSmsDetails
messageIdtenantIdsenderIdrecipientcontentstatusEnum values:
New
Queued
Sending
Sent
Failed
Delivered
Received
PartialReceived
smscConfigIdUsedproviderMessageIdscreatedAtscheduledSendTimesubmittedAtlastAttemptAtdeliveredAtfailedAtfailureReasonerrorCoderetryAttempts^-?(?:0|[1-9]\d*)$clientCorrelationIdbatchIdobject[]
sourceIpAddresssentViaProviderEnum values:
Unknown
LiberiaMtn
LiberiaOrange
SmsHistoryEntry
timestampstatusEnum values:
New
Queued
Sending
Sent
Failed
Delivered
Received
PartialReceived
notesSmsHistoryResult
object[]
totalCount^-?(?:0|[1-9]\d*)$object
nextPageTokenSmsMessageSummary
messageIdtenantIdsenderIdrecipientstatusEnum values:
New
Queued
Sending
Sent
Failed
Delivered
Received
PartialReceived
createdAtsubmittedAtdeliveredAtfailedAtfailureReasonerrorCodebatchIdStatusWebhookResponse
subscriptionIdtenantIdurlhasSecretisActivenamehttpMethodbodyTemplatequeryParamTemplatenull | object · required
sourceIpFiltersallowedStatuscreatedAtupdatedAtTenantSenderIdStatsDto
totalAllocated^-?(?:0|[1-9]\d*)$activeCount^-?(?:0|[1-9]\d*)$pendingCount^-?(?:0|[1-9]\d*)$expiredCount^-?(?:0|[1-9]\d*)$suspendedCount^-?(?:0|[1-9]\d*)$object
totalUsage^-?(?:0|[1-9]\d*)$mostRecentlyUsedSenderIdmostRecentUsageAtUpdateContactDto
phoneNumber^\+[1-9]\d{1,14}$firstNamelastNameemailcompanytagsnull | object
UpdateRuleRequest
actionTypeEnum values:
Webhook
GrainForward
targetisActivesecretUpdateStatusWebhookRequest
urlsecretisActivenamehttpMethodDefault: POST
bodyTemplatequeryParamTemplatenull | object
sourceIpFiltersallowedStatus