Tech231 Platform USSD API
string · requiredstring · requiredstring · requiredstring · requiredstring · uuidstring · date-timenull | string · date-timeinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: stringstringstringnull | stringnull | stringnull | stringstringstringenumnull | stringstringstringstringstringstring · minLength: 0 · maxLength: 200 · requirednull | string · minLength: 0 · maxLength: 1000string · requiredstring · minLength: 0 · maxLength: 1000 · requirednull | stringstring · minLength: 0 · maxLength: 200 · requiredstring · minLength: 0 · maxLength: 500 · requiredstring · pattern: integer · requirednull | string · pattern: string · minLength: 1 · maxLength: 200 · pattern: string · requiredstring · minLength: 0 · maxLength: 500 · pattern: string · requiredstring · requirednull | integer | string · int32 · pattern: null | integer | string · int32 · pattern: string · requiredstring · requiredstring · requiredstring · requiredstring · uuidstring · date-timebooleannull | stringnull | stringnull | stringnull | stringnull | integer | string · int32 · pattern: null | integer | string · int32 · pattern: stringstringnull | stringstring · date-timeinteger | string · int64 · pattern: integer | string · int32 · pattern: string · requiredstring · requiredstring · requirednull | stringnull | string · minLength: 0 · maxLength: 100null | stringbooleanbooleannull | string · minLength: 0 · maxLength: 128 · pattern: string · requiredstring · pattern: string · requiredstring · requirednull | stringstringnull | stringbooleanstring · requiredstring · requiredstring · requiredstring · requiredstring · requiredinteger | string · int32 · pattern: booleaninteger | string · int32 · pattern: null | stringstring · date-timestring · requirednull | stringstringnull | stringnull | stringnull | stringbooleannull | stringinteger | string · int32 · pattern: integer | string · int32 · pattern: booleanstring · requiredstring · requiredbooleannull | stringnull | stringstring · minLength: 2 · maxLength: 100 · pattern: string · minLength: 0 · maxLength: 500 · requirednull | string · minLength: 0 · maxLength: 2000string · requiredstring · requirednull | stringbooleanrequiredstring · requirednull | string · minLength: 0 · maxLength: 500string · requiredstring · requiredstring · requiredbooleannull | stringstring · requiredbooleannull | stringnull | stringnull | stringnull | string · date-timenull | string · date-timenull | arraystringstringstringnull | stringstringstringnull | stringnull | stringstringstringstringnull | stringnull | stringnull | stringstringstringstringstringbooleaninteger | string · int32 · pattern: integer | string · int32 · pattern: null | stringstringstringstringstringstringobjectarraystringnull | stringnull | stringnull | stringbooleannull | stringnull | stringnull | stringstringstring · pattern: string · requirednull | stringnull | stringnull | stringstring · pattern: string · requiredstring · requirednull | stringnull | stringnull | stringnull | stringstring · requirednull | stringnull | stringnull | stringnull | stringnull | stringbooleannull | objectnull | string · minLength: 0 · maxLength: 200null | string · minLength: 0 · maxLength: 1000string · minLength: 0 · maxLength: 500 · pattern: null | string · minLength: 0 · maxLength: 200null | string · minLength: 0 · maxLength: 500string · minLength: 0 · maxLength: 4000 · requirednull | string · minLength: 0 · maxLength: 100booleannull | string · minLength: 0 · maxLength: 128 · pattern: null | string · urinull | stringnull | stringnull | stringnull | stringnull | stringnull | integer | string · int32 · min: 1 · max: 3 · pattern: null | integer | string · int32 · min: 1 · max: 120 · pattern: null | string · minLength: 0 · maxLength: 500null | string · minLength: 0 · maxLength: 500null | string · uri · minLength: 0 · maxLength: 500null | string · minLength: 0 · maxLength: 500null | string · minLength: 0 · maxLength: 500string · uuidstringstringstringstring · date-timestring · uuidstringstringstringstringnull | stringintegerstringstring · date-timenull | string · date-timestring · requiredinteger | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern: integer | string · int32 · pattern:
ApplicationMetadataResponseDto
nameshortCodeversionstatusapplicationIddeployedAtlastUpdatedAtBuilderApplicationListResponseDto
object[]
total^-?(?:0|[1-9]\d*)$page^-?(?:0|[1-9]\d*)$pageSize^-?(?:0|[1-9]\d*)$BuilderApplicationResponseDto
idtenantIdnamedescriptionshortcodesubcodeentryDataappTypestatusEnum values:
Draft
Published
Inactive
liveVersionIdcreatedAtupdatedAtcreatedByupdatedByCreateBuilderApplicationDto
namedescriptionCreateShortcodeRequestDto
shortcodejustificationsubcodeCreateUssdApplicationDto
nameentryDatashortCode^\d{3,5}$ · requiredappTypesubCode^\d{2,5}$DeployRelayApplicationRequestDto
name^[a-zA-Z0-9_-]+$ · requiredshortCodeendpointUrl^https:// · requiredDeploymentErrorDto
codemessageline^-?(?:0|[1-9]\d*)$column^-?(?:0|[1-9]\d*)$DeploymentResponseDto
nameshortCodeversionstatusapplicationIddeployedAtDslValidationResponseDto
object[] · required
isValidapplicationNameversionshortCodestartBlockmenuCount^-?(?:0|[1-9]\d*)$actionCount^-?(?:0|[1-9]\d*)$GatewayAdapterResponseDto
countryTelcoIdgrainTypemetadataregisteredAtGatewayRegistryStatusDto
registryVersion^-?(?:0|[1-9]\d*)$adapterCount^-?(?:0|[1-9]\d*)$object[]
GenericSecretDto
namereferencescopeapplicationIdcategoryvalueMaskedhasValueexposeAsEnvenvVarName^[A-Za-z_][A-Za-z0-9…InboundRequestDto
sessionIdmsisdn^\d{10,15}$ · requiredshortCodeproviderinputrequestTypeserviceCodeisInitiationMtnPushSessionResponseDto
sessionIdmsisdnshortCodeapplicationNameinitialTextpushType^-?(?:0|[1-9]\d*)$gatewayAcceptedgatewayStatusCode^-?(?:0|[1-9]\d*)$gatewayResponsesentAtMtnPushSettingsResponseDto
sourcebaseUrlpushPathserviceCodeuserIdpasswordMaskedhasPasswordtypepushType^-?(?:0|[1-9]\d*)$timeoutSeconds^-?(?:0|[1-9]\d*)$isConfiguredOutboundResponseDto
sessionIdtextendSessioncurrentStatetraceId
RegisterGatewayAdapterDto
countryTelcoId^[a-z]{2}-[a-z0-9]+$ · requiredgrainTypemetadataRemoteCallAuthSecretDto
namereferencevalueMaskedhasValueSaveVersionDto
flowGraphdslSourcechangeDescriptionSessionResponseDto
sessionIdresponseTypetextisActivecurrentMenuSessionStateResponseDto
sessionIdisActivemsisdncurrentMenuapplicationNamestartedAtlastActivityAtnavigationHistorynull | object
ShortcodeRequestResponseDto
idtenantIdshortcodesubcodejustificationstatusrejectionReasonapplicationIdcreatedAtupdatedAtcreatedBycreatedByNamereviewedBytenantNameSimulatorGatewayResponseDto
gatewayIdbodyencodingcontentTypeobject
truncatedcharactersIn^-?(?:0|[1-9]\d*)$charactersOut^-?(?:0|[1-9]\d*)$errorSimulatorSessionResponseDto
idapplicationIdcurrentNodeIdscreenContentinputTypenull | array
variablesactionHistorystatuserror
SmsIntegrationSecretsResponseDto
clientIdclientSecretMaskedhasClientSecretissueraudiencescopessourceStartMtnPushSessionRequestDto
msisdn^\d{10,15}$ · requiredshortCodeapplicationNameinitialInputsessionIdStartSessionRequestDto
msisdn^\d{10,15}$ · requiredshortCodeapplicationNameinitialInputsessionIdgatewaySessionIdgatewayStartSimulatorSessionDto
applicationIddslSourceflowGraphgatewayIdmsisdnshortCodesessionIdmockModemockResponsesUpdateBuilderApplicationDto
namedescription
UpdateRelayEndpointRequestDto
endpointUrl^https:// · requiredUpdateUssdApplicationDto
nameentryData
UpsertGenericSecretDto
valuecategoryexposeAsEnvenvVarName^[A-Za-z_][A-Za-z0-9…UpsertMtnPushSettingsDto
baseUrlpushPathserviceCodeuserIdpasswordtypepushType^-?(?:0|[1-9]\d*)$timeoutSeconds^-?(?:0|[1-9]\d*)$UpsertSmsIntegrationSecretsDto
clientIdclientSecretissueraudiencescopesUssdAppBrief
idnameshortCodestatuslastModifiedUssdApplicationResponseDto
idtenantIdnameentryDatashortCodesubCodeappTypecreatedBycreatedAtupdatedAtUssdDashboardOverviewResponse
tenantIdtotalApplications^-?(?:0|[1-9]\d*)$published^-?(?:0|[1-9]\d*)$draft^-?(?:0|[1-9]\d*)$inactive^-?(?:0|[1-9]\d*)$shortcodesInUse^-?(?:0|[1-9]\d*)$object[]