{"items":[{"type":"link","label":"Promotexter API","link":"/api","routeSlug":"/api","content":{"contentType":"overview","meta":{"name":"Promotexter API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Promotexter API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter API Reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Promotexter API provides REST-based services for multi-channel communication, supporting SMS, Email, Viber, WhatsApp, verification, and voice calls that allows you to integrate multi-channel communication directly into your web applications, platforms, and CRM software."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"style":{"fontSize":"1.35em"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Start Guide"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started with Promotexter takes just three steps:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an account by contacting your Account Manager at sales@promotexter.com or our Support team at support@promotexter.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist your IP address to access the Promotexter API services by contacting the Support team."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate your Promotexter token or API key and secret. Obtain your secure API key and secret from the portal, or follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/api/api-authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain your token."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once everything is set up, you are now ready to send your first request by using your Promotexter token or API key and secret for authentication."},"children":[]}]}]}]}],"sectionId":"/api"}],"sectionId":"/api"}]}]}},{"type":"separator","label":"Get started","content":null},{"type":"group","label":"Account Registration","link":"/api/account-registration","routeSlug":"/api/account-registration","items":[],"content":{"contentType":"group","meta":{"name":"Account Registration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Registration","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Promotexter account at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://portal.promotexter.com","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://portal.promotexter.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by contacting your Account Manager at sales@promotexter.com or the Support team at support@promotexter.com. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your account grants you access to the API, web-based portal, and other Promotexter services."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-registration"}],"panels":[]}]}},{"type":"group","label":"IP Whitelisting","link":"/api/ip-whitelisting","routeSlug":"/api/ip-whitelisting","items":[],"content":{"contentType":"group","meta":{"name":"IP Whitelisting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Whitelisting","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accessing Promotexter API services requires an authorized IP address. Please contact the Support team at support@promotexter.com to have your IP address whitelisted."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-whitelisting"}],"panels":[]}]}},{"type":"group","label":"API Authentication","link":"/api/api-authentication","routeSlug":"/api/api-authentication","items":[{"label":"Generate Promotexter token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/api-authentication/generatepromotextertoken","routeSlug":"/api/api-authentication/generatepromotextertoken","metadata":{"seo":{"title":"Generate Promotexter token","description":"Generate a Promotexter token using the client token and expiresInSeconds required field.Authentication: use a valid client token in the Authorization header using the format Bearer [client-token].Rate limit: maximum of 5 requests per minute. Once exceeded, error 40002: Too many requests. is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generatePromotexterToken","name":"Generate Promotexter token","isWebhook":false,"pointer":"/paths/~1generate-token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Promotexter token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a Promotexter token using the client token and expiresInSeconds required field."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use a valid "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header using the format "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer [client-token]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" maximum of 5 requests per minute. Once exceeded, error "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"40002: Too many requests."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_13","description":"Client token in bearer format.","required":true,"example":"Bearer your-client-token"}],"pointer":"/paths/~1generate-token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GeneratePromotexterTokenRequest","exampleIds":["paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/GeneratePromotexterTokenRequest","exampleIds":["paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1generate-token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/generate-token","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"example":"Bearer your-client-token","schemaId":"schema_13"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GeneratePromotexterTokenRequest","exampleIds":["paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","400","401","422"],"pointer":"/generate-token","href":"api-authentication/generatepromotextertoken","openApiOperationId":"generatePromotexterToken","summary":"Generate Promotexter token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/GeneratePromotexterTokenRequest","exampleIds":["paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GeneratePromotexterTokenRequest","exampleIds":["paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing the Promotexter token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GeneratePromotexterTokenResponse","exampleIds":["paths/~1generate-token/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/GeneratePromotexterTokenResponse","exampleIds":["paths/~1generate-token/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1generate-token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GeneratePromotexterTokenResponse","exampleIds":["paths/~1generate-token/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GeneratePromotexterTokenResponse","exampleIds":["paths/~1generate-token/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-authentication/generatepromotextertoken"}],"panels":[]}]},"httpPath":"/generate-token"}],"content":{"contentType":"group","meta":{"name":"API Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Authentication","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to generate a Promotexter token by authenticating with a client token. The new token can then be used as a bearer token for API requests, such as Viber, WhatsApp, SMS, and Email APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate a client token, please refer "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/clienttoken","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Alternatively, you can use the traditional approach of an API key and secret for authenticating Viber, WhatsApp, SMS, and Email APIs, if your system integration requires it."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/generate-token","summary":"Generate Promotexter token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-authentication/generatepromotextertoken","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account","content":null},{"type":"group","label":"Account Balance","link":"/api/account-balance","routeSlug":"/api/account-balance","items":[{"label":"Get account balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-balance/getaccountbalance","routeSlug":"/api/account-balance/getaccountbalance","metadata":{"seo":{"title":"Get account balance","description":"Retrieves the current account balance available for messaging or other service usage.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret as query parameters. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountBalance","name":"Get account balance","isWebhook":false,"pointer":"/paths/~1api~1account~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current account balance available for messaging or other service usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as query parameters. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"apiKey","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},{"name":"apiSecret","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"}],"pointer":"/paths/~1api~1account~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/account/balance","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[{"name":"apiKey","in":"query","example":"your-api-key","schemaId":"schema_13"},{"name":"apiSecret","in":"query","example":"your-api-secret","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","422"],"pointer":"/api/account/balance","href":"account-balance/getaccountbalance","openApiOperationId":"getAccountBalance","summary":"Get account balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing account balance details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAccountBalanceResponse","exampleIds":["paths/~1api~1account~1balance/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/getAccountBalanceResponse","exampleIds":["paths/~1api~1account~1balance/get/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/HeaderParamValidationError"}},"schemaId":"components/schemas/HeaderParamValidationError"}],"pointer":"/paths/~1api~1account~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getAccountBalanceResponse","exampleIds":["paths/~1api~1account~1balance/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAccountBalanceResponse","exampleIds":["paths/~1api~1account~1balance/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/HeaderParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/HeaderParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-balance/getaccountbalance"}],"panels":[]}]},"httpPath":"/api/account/balance"}],"content":{"contentType":"group","meta":{"name":"Account Balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Balance","showPageActions":true},{"nodeType":"markdoc","content":"This allows you to view your current account balance for tracking usage across messaging, verification, and other platform services."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/account/balance","summary":"Get account balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-balance/getaccountbalance","deprecated":false}]}]}]}]}},{"type":"separator","label":"Business Messages","content":null},{"type":"group","label":"Viber Business Messaging","link":"/api/viber-business-messaging","routeSlug":"/api/viber-business-messaging","items":[{"label":"Send Viber with optional SMS fallback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/viber-business-messaging/sendviber","routeSlug":"/api/viber-business-messaging/sendviber","metadata":{"seo":{"title":"Send Viber with optional SMS fallback","description":"Send a Viber message using the required Viber channel ID and recipient fields, choose one message type or template payload, and optionally include SMS fallback, ttl, callback and reference ID fields.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendViber","name":"Send Viber with optional SMS fallback","isWebhook":false,"pointer":"/paths/~1viber~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Viber with optional SMS fallback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a Viber message using the required Viber channel ID and recipient fields, choose one message type or template payload, and optionally include SMS fallback, ttl, callback and reference ID fields."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14","pointer":"/paths/~1viber~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/viber/send","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_14"}},"responseCodes":["200","400","401","422"],"pointer":"/viber/send","href":"viber-business-messaging/sendviber","openApiOperationId":"sendViber","summary":"Send Viber with optional SMS fallback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1viber~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/dlrCallback}","summary":"[Legacy] DLR Notification","operationId":"viberDlrCallbackInline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Only one DLR notification will be sent per request, even if the transaction falls back to SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Certain transaction-related errors may also be returned through this callback."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the Viber ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, please contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&referenceId=%r&timestamp=%d&from=%f&transactionType=%tr&to=%t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-business-messaging/sendviber/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/viber-business-messaging/sendviber#viber-business-messaging/sendviber/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your DLR callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback","callbackId":"dlr_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"referenceId","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference ID provided in the original request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"TXN-001"},{"name":"transactionType","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"viber"},{"name":"from","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber channel ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"2026-05-25T07:41:09.031Z"},{"name":"to","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"639123456789"},{"name":"mobileNumber","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"639123456789"},{"name":"errorCode","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code associated with the transaction-related error. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"200236"}],"pointer":"/paths/~1viber~1send/post/callbacks/dlr_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send/post/callbacks/dlr_callback/get/responses"}]},"pointer":"/paths/~1viber~1send/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/eventCallback}","summary":"[Legacy] Event Notification","operationId":"viberEventCallbackInline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Event notification is only applicable to transactions delivered via Viber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for event status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the event is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobileNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example event callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&timestamp=%d&to=%t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example event callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-business-messaging/sendviber/callbacks/event_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/viber-business-messaging/sendviber#viber-business-messaging/sendviber/callbacks/event_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your event callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"event_callback","callbackId":"event_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Event status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8000"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the event is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"mobileNumber","in":"query","schemaId":"schema_13","description":"Recipient mobile number.","example":"639123456789"}],"pointer":"/paths/~1viber~1send/post/callbacks/event_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send/post/callbacks/event_callback/get/responses"}]},"pointer":"/paths/~1viber~1send/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/dlrCallbackConfig}","summary":"DLR Notification","operationId":"viberDlrCallbackConfigInline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Only one DLR notification will be sent per request, even if the transaction falls back to SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Certain transaction-related errors may also be returned through this callback."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the Viber ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"transactionType\": \"%tr\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"transactionType\": \"%tr\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-business-messaging/sendviber/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/viber-business-messaging/sendviber#viber-business-messaging/sendviber/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback_config","callbackId":"dlr_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_15"}},"schemaId":"schema_15","pointer":"/paths/~1viber~1send/post/callbacks/dlr_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send/post/callbacks/dlr_callback_config/post/responses"}]},"pointer":"/paths/~1viber~1send/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"dlr_callback_config/post","path":"{$request.body#/dlrCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_15"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/eventCallbackConfig}","summary":"Event Notification","operationId":"viberEventCallbackConfigInline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Event notification is only applicable to transactions delivered via Viber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for event status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the event is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobileNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example event callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  \"eventCallbackConfig\": {\n    \"url\": \"https://your-server.com/callback\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"id\": \"%i\",\n      \"status\": \"%s\",\n      \"timestamp\": \"%d\",\n      \"mobileNumber\": \"%t\"\n    }\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  \"eventCallbackConfig\": {\n    \"url\": \"https://your-server.com/callback\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"id\": \"%i\",\n      \"status\": \"%s\",\n      \"timestamp\": \"%d\",\n      \"mobileNumber\": \"%t\"\n    }\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-business-messaging/sendviber/callbacks/event_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/viber-business-messaging/sendviber#viber-business-messaging/sendviber/callbacks/event_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"event_callback_config","callbackId":"event_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16","pointer":"/paths/~1viber~1send/post/callbacks/event_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send/post/callbacks/event_callback_config/post/responses"}]},"pointer":"/paths/~1viber~1send/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"event_callback_config/post","path":"{$request.body#/eventCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/viber-business-messaging/sendviber"}],"panels":[]}]},"httpPath":"/viber/send"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Receive Inbound Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/viber-business-messaging/receiveviberinboundmessageswebhook","routeSlug":"/api/viber-business-messaging/receiveviberinboundmessageswebhook","metadata":{"seo":{"title":"Receive Inbound Messages","description":"Receive Viber inbound messages through your dedicated replyable Viber channel to your configured webhook URL in real-time (via GET method by default)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"receiveViberInboundMessagesWebhook","name":"Receive Inbound Messages","isWebhook":true,"pointer":"/paths/~1your~1webhook~1path/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receive Inbound Messages","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive Viber inbound messages through your dedicated replyable Viber channel to your configured webhook URL in real-time (via GET method by default)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following inbound messages can be received:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"video"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioning a channel:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact your Account Manager at sales@promotexter.com to provision a replyable Viber channel. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical setup:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact support@promotexter.com to configure your webhook URL or request the POST method if your integration requires it. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URL format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{yourDomain}/yourwebhookpath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Do not add query attributes to your webhook URL. Promotexter appends these query parameters automatically when forwarding inbound messages."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"channel_id","in":"query","schemaId":"schema_13","description":"ID of your Viber channel.","example":"1234"},{"name":"channel_name","in":"query","schemaId":"schema_13","description":"Name of your Viber channel.","example":"Promotexter 2way"},{"name":"content[text]","in":"query","schemaId":"schema_13","description":"Text content of the inbound Viber message. Returned for text content.","example":"This is a test"},{"name":"content[fileName]","in":"query","schemaId":"schema_13","description":"File name of the inbound media attachment. Returned for media content.","example":"samplefile.jpg"},{"name":"content[media]","in":"query","schemaId":"schema_13","description":"URL of the inbound media attachment. Returned for media content.","example":"https://mediaurl.com/samplefile.jpg"},{"name":"mobile_number","in":"query","schemaId":"schema_13","description":"Sender mobile number of the inbound Viber message.","example":"+639995671234"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the message is received (UTC).","example":"2021-12-01T03:30:55.310Z"},{"name":"transaction_id","in":"query","schemaId":"schema_13","description":"Unique transaction ID of the inbound Viber message.","example":"843"}],"pointer":"/paths/~1your~1webhook~1path/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"GET","path":"/your/webhook/path","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://{yourDomain}","variables":{"yourDomain":{"default":"example.com"}}}],"parameters":{"path":[],"query":[{"name":"channel_id","in":"query","example":"1234","schemaId":"schema_13"},{"name":"channel_name","in":"query","example":"Promotexter 2way","schemaId":"schema_13"},{"name":"content[text]","in":"query","example":"This is a test","schemaId":"schema_13"},{"name":"content[fileName]","in":"query","example":"samplefile.jpg","schemaId":"schema_13"},{"name":"content[media]","in":"query","example":"https://mediaurl.com/samplefile.jpg","schemaId":"schema_13"},{"name":"mobile_number","in":"query","example":"+639995671234","schemaId":"schema_13"},{"name":"timestamp","in":"query","example":"2021-12-01T03:30:55.310Z","schemaId":"schema_13"},{"name":"transaction_id","in":"query","example":"843","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/your/webhook/path","href":"viber-business-messaging/receiveviberinboundmessageswebhook","openApiOperationId":"receiveViberInboundMessagesWebhook","summary":"Receive Inbound Messages"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://{yourDomain}","variables":{"yourDomain":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1your~1webhook~1path/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/viber-business-messaging/receiveviberinboundmessageswebhook"}],"panels":[]}]},"httpPath":"/your/webhook/path"}],"content":{"contentType":"group","meta":{"name":"Viber Business Messaging"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Viber Business Messaging","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to send a Viber Business Message to a single mobile number per request with fallback to SMS as an option if the recipient cannot be reached via Viber within the configured message lifetime ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ttl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and receive inbound Viber messages through your configured webhook URL. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported outbound message types and templates include Text, Image, Video, Call-to-Action Button, and Transactional Templates, while inbound supports text and media webhook events."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/viber/send","summary":"Send Viber with optional SMS fallback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/viber-business-messaging/sendviber","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/your/webhook/path","summary":"Receive Inbound Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/viber-business-messaging/receiveviberinboundmessageswebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Business Messaging","link":"/api/whatsapp-business-messaging","routeSlug":"/api/whatsapp-business-messaging","items":[{"label":"Send WhatsApp with optional SMS fallback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/whatsapp-business-messaging/sendwhatsapp","routeSlug":"/api/whatsapp-business-messaging/sendwhatsapp","metadata":{"seo":{"title":"Send WhatsApp with optional SMS fallback","description":"Sends a WhatsApp message using Meta-compatible payload structure and optionally enables SMS fallback when WhatsApp delivery fails for supported cases.Note: The below WhatsApp error codes will trigger SMS fallback when the required SMS fallback parameters are included in the request. SMS fallback is not supported for reaction messages.131049 - This message was not delivered to maintain healthy ecosystem engagement.131050 - Unable to deliver the message. This recipient has chosen to stop receiving marketing messages on WhatsApp from your business.131026 - Unable to deliver message. Reasons can include the recipient not being a WhatsApp user, not having accepted the latest Terms of Service and Privacy Policy, or using an outdated WhatsApp version.131047 - More than 24 hours have passed since the recipient last replied to the sender number. Send the recipient a template message instead.131062 - Business-scoped User ID (BSUID) recipients are not supported for this message.See WhatsApp error codes.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendWhatsApp","name":"Send WhatsApp with optional SMS fallback","isWebhook":false,"pointer":"/paths/~1whatsapp~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send WhatsApp with optional SMS fallback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a WhatsApp message using Meta-compatible payload structure and optionally enables SMS fallback when WhatsApp delivery fails for supported cases."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The below WhatsApp error codes will trigger SMS fallback when the required SMS fallback parameters are included in the request. SMS fallback is not supported for reaction messages."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ol","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131049"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This message was not delivered to maintain healthy ecosystem engagement."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131050"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unable to deliver the message. This recipient has chosen to stop receiving marketing messages on WhatsApp from your business."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131026"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unable to deliver message. Reasons can include the recipient not being a WhatsApp user, not having accepted the latest Terms of Service and Privacy Policy, or using an outdated WhatsApp version."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131047"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - More than 24 hours have passed since the recipient last replied to the sender number. Send the recipient a template message instead."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131062"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Business-scoped User ID (BSUID) recipients are not supported for this message."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/support/error-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp error codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendWhatsAppRequest"}},"schemaId":"components/schemas/SendWhatsAppRequest","pointer":"/paths/~1whatsapp~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/whatsapp/send","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SendWhatsAppRequest"}},"responseCodes":["200","400","401","422"],"pointer":"/whatsapp/send","href":"whatsapp-business-messaging/sendwhatsapp","openApiOperationId":"sendWhatsApp","summary":"Send WhatsApp with optional SMS fallback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/SendWhatsAppRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendWhatsAppRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1whatsapp~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/callbackConfig/url}","summary":"DLR and Event Notifications","operationId":"whatsappCallbackConfigInline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR and event notifications are sent through a POST request to the callback URL specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callbackConfig.url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only one DLR notification will be sent per request, even if the transaction falls back to SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Certain transaction-related errors may also be returned through this callback. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use the following placeholders in your callback request body, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for callback status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the callback is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp sender phone number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient mobile number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%bsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient BSUID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%pbsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parentBsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient parent BSUID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%p"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp contacts object returned by WhatsApp as-is."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%pc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricingCategory"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp pricing category returned by WhatsApp as-is."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%pt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricingType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp pricing type returned by WhatsApp as-is."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%mo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"marketingOptimized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the marketing optimized marker."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  \"callbackConfig\": {\n    \"url\": \"https://example.com\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"status\": \"%s\",\n      \"id\": \"%i\",\n      \"referenceId\": \"%r\",\n      \"timestamp\": \"%d\",\n      \"from\": \"%f\",\n      \"transactionType\": \"%tr\",\n      \"to\": \"%t\",\n      \"bsuid\": \"%bsuid\",\n      \"parentBsuid\": \"%pbsuid\",\n      \"contacts\": \"%p\",\n      \"pricingCategory\": \"%pc\",\n      \"pricingType\": \"%pt\",\n      \"marketingOptimized\": \"%mo\"\n    }\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  \"callbackConfig\": {\n    \"url\": \"https://example.com\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"status\": \"%s\",\n      \"id\": \"%i\",\n      \"referenceId\": \"%r\",\n      \"timestamp\": \"%d\",\n      \"from\": \"%f\",\n      \"transactionType\": \"%tr\",\n      \"to\": \"%t\",\n      \"bsuid\": \"%bsuid\",\n      \"parentBsuid\": \"%pbsuid\",\n      \"contacts\": \"%p\",\n      \"pricingCategory\": \"%pc\",\n      \"pricingType\": \"%pt\",\n      \"marketingOptimized\": \"%mo\"\n    }\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"whatsapp-business-messaging/sendwhatsapp/callbacks/callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/whatsapp-business-messaging/sendwhatsapp#whatsapp-business-messaging/sendwhatsapp/callbacks/callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_transactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_bsuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_parentBsuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_contacts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_pricingCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_pricingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_marketingOptimized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"callback_config","callbackId":"callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsAppCallbackPayload"}},"schemaId":"components/schemas/WhatsAppCallbackPayload","pointer":"/paths/~1whatsapp~1send/post/callbacks/callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1whatsapp~1send/post/callbacks/callback_config/post/responses"}]},"pointer":"/paths/~1whatsapp~1send/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"callback_config/post","path":"{$request.body#/callbackConfig/url}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-business-messaging/sendwhatsapp"}],"panels":[]}]},"httpPath":"/whatsapp/send"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Receive Inbound Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/whatsapp-business-messaging/receivewhatsappinboundmessageswebhook","routeSlug":"/api/whatsapp-business-messaging/receivewhatsappinboundmessageswebhook","metadata":{"seo":{"title":"Receive Inbound Messages","description":"Receive WhatsApp inbound messages through your WhatsApp channel to your configured webhook URL in real-time (via GET method by default)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"receiveWhatsAppInboundMessagesWebhook","name":"Receive Inbound Messages","isWebhook":true,"pointer":"/paths/~1your~1whatsapp~1webhook~1path/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receive Inbound Messages","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive WhatsApp inbound messages through your WhatsApp channel to your configured webhook URL in real-time (via GET method by default)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following inbound messages can be received:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"audio"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"button"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interactive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revoke (deletes a previously sent message)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sticker"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"video"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp inbound messages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for further details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioning a channel:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact your Account Manager at sales@promotexter.com to set up a WhatsApp Channel. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical setup:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact support@promotexter.com to configure your webhook URL or request the POST method if your integration requires it. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URL format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{yourDomain}/yourwebhookpath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Do not add query attributes to your webhook URL. Promotexter appends these query parameters automatically when forwarding inbound messages."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"transaction_id","in":"query","schemaId":"schema_13","description":"Unique transaction ID of the inbound WhatsApp message.","example":"843"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the message is received (UTC).","example":"2026-08-13T10:40:21.011Z"},{"name":"from","in":"query","schemaId":"schema_13","description":"Sender mobile number of the inbound WhatsApp message.","example":"639123456789"},{"name":"to","in":"query","schemaId":"schema_13","description":"Your WhatsApp phone number.","example":"15554443332"},{"name":"bsuid","in":"query","schemaId":"schema_13","description":"Sender BSUID of the inbound WhatsApp message.","example":"PH.1234567891011121"},{"name":"parentBsuid","in":"query","schemaId":"schema_13","description":"Sender parent BSUID of the inbound WhatsApp message.","example":"PH.1234567891011000"}],"pointer":"/paths/~1your~1whatsapp~1webhook~1path/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"GET","path":"/your/whatsapp/webhook/path","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://{yourDomain}","variables":{"yourDomain":{"default":"example.com"}}}],"parameters":{"path":[],"query":[{"name":"transaction_id","in":"query","example":"843","schemaId":"schema_13"},{"name":"timestamp","in":"query","example":"2026-08-13T10:40:21.011Z","schemaId":"schema_13"},{"name":"from","in":"query","example":"639123456789","schemaId":"schema_13"},{"name":"to","in":"query","example":"15554443332","schemaId":"schema_13"},{"name":"bsuid","in":"query","example":"PH.1234567891011121","schemaId":"schema_13"},{"name":"parentBsuid","in":"query","example":"PH.1234567891011000","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/your/whatsapp/webhook/path","href":"whatsapp-business-messaging/receivewhatsappinboundmessageswebhook","openApiOperationId":"receiveWhatsAppInboundMessagesWebhook","summary":"Receive Inbound Messages"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://{yourDomain}","variables":{"yourDomain":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1your~1whatsapp~1webhook~1path/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-business-messaging/receivewhatsappinboundmessageswebhook"}],"panels":[]}]},"httpPath":"/your/whatsapp/webhook/path"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Business Messaging"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Business Messaging","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to send WhatsApp templated and free-form messages to a single mobile number per request with fallback to SMS as an option if the recipient cannot be reached via WhatsApp within the message lifetime for supported cases, and receive inbound WhatsApp messages through your configured webhook URL. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Promotexter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/whatsapp/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API handles routing to either Meta's WhatsApp Cloud API (for utility, authentication and service messages) or Marketing Messages API (for marketing messages with automatic fallback to Cloud API)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/whatsapp/send","summary":"Send WhatsApp with optional SMS fallback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/whatsapp-business-messaging/sendwhatsapp","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/your/whatsapp/webhook/path","summary":"Receive Inbound Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/whatsapp-business-messaging/receivewhatsappinboundmessageswebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"SMS Messaging","link":"/api/sms-messaging","routeSlug":"/api/sms-messaging","items":[{"label":"Send SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-messaging/sendsms","routeSlug":"/api/sms-messaging/sendsms","metadata":{"seo":{"title":"Send SMS","description":"Sends an SMS message using the required sender ID, recipient and text fields and optionally include callback and reference ID fields.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendSms","name":"Send SMS","isWebhook":false,"pointer":"/paths/~1sms~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends an SMS message using the required sender ID, recipient and text fields and optionally include callback and reference ID fields."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendSmsRequest","exampleIds":["paths/~1sms~1send/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SendSmsRequest","exampleIds":["paths/~1sms~1send/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1sms~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sms/send","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SendSmsRequest","exampleIds":["paths/~1sms~1send/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","422"],"pointer":"/sms/send","href":"sms-messaging/sendsms","openApiOperationId":"sendSms","summary":"Send SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/SendSmsRequest","exampleIds":["paths/~1sms~1send/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendSmsRequest","exampleIds":["paths/~1sms~1send/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing SMS transaction details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsResponse","exampleIds":["paths/~1sms~1send/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/SmsResponse","exampleIds":["paths/~1sms~1send/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1sms~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SmsResponse","exampleIds":["paths/~1sms~1send/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsResponse","exampleIds":["paths/~1sms~1send/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/dlrCallback}","summary":"[Legacy] DLR Notification","operationId":"smsDlrCallback","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the sender ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, please contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&referenceId=%r&timestamp=%d&transactionType=%tr&from=%f&to=%t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sms-messaging/sendsms/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/sms-messaging/sendsms#sms-messaging/sendsms/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your DLR callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback","callbackId":"dlr_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/statuscodes#sms-status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"referenceId","in":"query","schemaId":"schema_13","description":"Reference ID provided in the original request.","example":"TXN-001"},{"name":"transactionType","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sms"},{"name":"from","in":"query","schemaId":"schema_13","description":"SMS sender ID.","example":"PTXTrial"},{"name":"to","in":"query","schemaId":"schema_13","description":"Recipient mobile number.","example":"639123456789"}],"pointer":"/paths/~1sms~1send/post/callbacks/dlr_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1sms~1send/post/callbacks/dlr_callback/get/responses"}]},"pointer":"/paths/~1sms~1send/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/dlrCallbackConfig}","summary":"DLR Notification","operationId":"smsDlrCallbackConfig","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the sender ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"transactionType\": \"%tr\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"transactionType\": \"%tr\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sms-messaging/sendsms/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/sms-messaging/sendsms#sms-messaging/sendsms/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback_config","callbackId":"dlr_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18","pointer":"/paths/~1sms~1send/post/callbacks/dlr_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1sms~1send/post/callbacks/dlr_callback_config/post/responses"}]},"pointer":"/paths/~1sms~1send/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"dlr_callback_config/post","path":"{$request.body#/dlrCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-messaging/sendsms"}],"panels":[]}]},"httpPath":"/sms/send"},{"label":"Retrieve SMS","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-messaging/retrievesmstransactions","routeSlug":"/api/sms-messaging/retrievesmstransactions","metadata":{"seo":{"title":"Retrieve SMS","description":"Retrieves SMS transactions via a single API call with pagination, sorting, and filter support.Authentication options: either send a Promotexter token in the Authorization header, or provide apiKey and apiSecret as query parameters. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveSmsTransactions","name":"Retrieve SMS","isWebhook":false,"pointer":"/paths/~1api~1sms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves SMS transactions via a single API call with pagination, sorting, and filter support."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either send a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as query parameters. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"apiKey","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},{"name":"apiSecret","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},{"name":"pageSize","in":"query","schemaId":"schema_19","description":"How many items per page.","example":10},{"name":"pageNumber","in":"query","schemaId":"schema_20","description":"Specify the page number.","example":1},{"name":"sortColumn","in":"query","schemaId":"schema_21","description":"Specify the sort column.","example":"dateCreated"},{"name":"sortDirection","in":"query","schemaId":"schema_22","description":"Specify the sort direction.","example":"descending"},{"name":"filter[dateCreatedGt]","in":"query","schemaId":"schema_13","description":"Filter transactions with creation date greater than this value.","example":"2023-03-01T00:00:00.000Z"},{"name":"filter[dateCreatedLt]","in":"query","schemaId":"schema_13","description":"Filter transactions with creation date earlier than this value.","example":"2023-03-31T23:59:59.999Z"},{"name":"filter[transactionId]","in":"query","schemaId":"schema_13","description":"Specific transactionId lookup.","example":"ab123524523cde134342343211342"},{"name":"filter[referenceId]","in":"query","schemaId":"schema_13","description":"Specific referenceId lookup.","example":"TXN-001"},{"name":"filter[requestId]","in":"query","schemaId":"schema_13","description":"Specific requestId lookup.","example":"4028fa7c-b2fa-4ed9-ad17-8a971b6dfa96"},{"name":"filter[from]","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"example":"Promotexter"},{"name":"filter[to]","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"example":"639170000001"}],"pointer":"/paths/~1api~1sms/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sms","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[{"name":"apiKey","in":"query","example":"your-api-key","schemaId":"schema_13"},{"name":"apiSecret","in":"query","example":"your-api-secret","schemaId":"schema_13"},{"name":"pageSize","in":"query","example":10,"schemaId":"schema_19"},{"name":"pageNumber","in":"query","example":1,"schemaId":"schema_20"},{"name":"sortColumn","in":"query","example":"dateCreated","schemaId":"schema_21"},{"name":"sortDirection","in":"query","example":"descending","schemaId":"schema_22"},{"name":"filter[dateCreatedGt]","in":"query","example":"2023-03-01T00:00:00.000Z","schemaId":"schema_13"},{"name":"filter[dateCreatedLt]","in":"query","example":"2023-03-31T23:59:59.999Z","schemaId":"schema_13"},{"name":"filter[transactionId]","in":"query","example":"ab123524523cde134342343211342","schemaId":"schema_13"},{"name":"filter[referenceId]","in":"query","example":"TXN-001","schemaId":"schema_13"},{"name":"filter[requestId]","in":"query","example":"4028fa7c-b2fa-4ed9-ad17-8a971b6dfa96","schemaId":"schema_13"},{"name":"filter[from]","in":"query","example":"Promotexter","schemaId":"schema_13"},{"name":"filter[to]","in":"query","example":"639170000001","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","422"],"pointer":"/api/sms","href":"sms-messaging/retrievesmstransactions","openApiOperationId":"retrieveSmsTransactions","summary":"Retrieve SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing paginated SMS transaction details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveSmsTransactionsResponse","exampleIds":["paths/~1api~1sms/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/RetrieveSmsTransactionsResponse","exampleIds":["paths/~1api~1sms/get/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1api~1sms/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveSmsTransactionsResponse","exampleIds":["paths/~1api~1sms/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveSmsTransactionsResponse","exampleIds":["paths/~1api~1sms/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-messaging/retrievesmstransactions"}],"panels":[]}]},"httpPath":"/api/sms"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Receive Inbound Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/sms-messaging/receivesmsinboundmessageswebhook","routeSlug":"/api/sms-messaging/receivesmsinboundmessageswebhook","metadata":{"seo":{"title":"Receive Inbound Messages","description":"Receive inbound SMS messages through your configured webhook URL in real-time (via GET method).  To provision an Access code or Virtual reply number (VRN), reach out to your Account Manager at sales@promotexter.com. If your integration requires POST method, contact support@promotexter.com."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"receiveSmsInboundMessagesWebhook","name":"Receive Inbound Messages","isWebhook":true,"pointer":"/paths/~1your~1sms~1webhook~1path/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receive Inbound Messages","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive inbound SMS messages through your configured webhook URL in real-time (via GET method). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To provision an Access code or Virtual reply number (VRN), reach out to your Account Manager at sales@promotexter.com. If your integration requires POST method, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URL format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{yourDomain}/yoursmswebhookpath?message=%message%&to=%to%&from=%from%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"message","in":"query","schemaId":"schema_13","description":"Content of the inbound SMS message.","example":"This is a test"},{"name":"to","in":"query","schemaId":"schema_13","description":"Your access code or VRN","example":"2256"},{"name":"from","in":"query","schemaId":"schema_13","description":"Sender mobile number of the inbound SMS message.","example":"+639995671234"}],"pointer":"/paths/~1your~1sms~1webhook~1path/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"GET","path":"/your/sms/webhook/path","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://{yourDomain}","variables":{"yourDomain":{"default":"example.com"}}}],"parameters":{"path":[],"query":[{"name":"message","in":"query","example":"This is a test","schemaId":"schema_13"},{"name":"to","in":"query","example":"2256","schemaId":"schema_13"},{"name":"from","in":"query","example":"+639995671234","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/your/sms/webhook/path","href":"sms-messaging/receivesmsinboundmessageswebhook","openApiOperationId":"receiveSmsInboundMessagesWebhook","summary":"Receive Inbound Messages"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://{yourDomain}","variables":{"yourDomain":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1your~1sms~1webhook~1path/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-messaging/receivesmsinboundmessageswebhook"}],"panels":[]}]},"httpPath":"/your/sms/webhook/path"}],"content":{"contentType":"group","meta":{"name":"SMS Messaging"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SMS Messaging","showPageActions":true},{"nodeType":"markdoc","content":"This allows you to send an SMS transaction to a single mobile number per request, retrieve SMS transactions, and also supports receiving inbound SMS messages."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sms/send","summary":"Send SMS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sms-messaging/sendsms","deprecated":false},{"title":"/api/sms","summary":"Retrieve SMS","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sms-messaging/retrievesmstransactions","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/your/sms/webhook/path","summary":"Receive Inbound Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sms-messaging/receivesmsinboundmessageswebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Email Messaging","link":"/api/email-messaging","routeSlug":"/api/email-messaging","items":[{"label":"Send email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/email-messaging/sendemail","routeSlug":"/api/email-messaging/sendemail","metadata":{"seo":{"title":"Send email","description":"Sends an email message using the required from email, recipient, email subject, email body, and html setting, and optionally include file attachment, callback and group name fields.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendEmail","name":"Send email","isWebhook":false,"pointer":"/paths/~1email/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends an email message using the required from email, recipient, email subject, email body, and html setting, and optionally include file attachment, callback and group name fields."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendEmailRequest","exampleIds":["paths/~1email/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SendEmailRequest","exampleIds":["paths/~1email/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1email/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/email","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SendEmailRequest","exampleIds":["paths/~1email/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","422"],"pointer":"/email","href":"email-messaging/sendemail","openApiOperationId":"sendEmail","summary":"Send email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/SendEmailRequest","exampleIds":["paths/~1email/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendEmailRequest","exampleIds":["paths/~1email/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing Email transaction details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailResponse","exampleIds":["paths/~1email/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/EmailResponse","exampleIds":["paths/~1email/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1email/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailResponse","exampleIds":["paths/~1email/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailResponse","exampleIds":["paths/~1email/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/dlrCallback}","summary":"[Legacy] DLR Notification","operationId":"emailDlrCallback","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, please contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&timestamp=%d&transactionType=%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"email-messaging/sendemail/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/email-messaging/sendemail#email-messaging/sendemail/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your DLR callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback","callbackId":"dlr_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/statuscodes#email-status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"delivered"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"transactionType","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"email"}],"pointer":"/paths/~1email/post/callbacks/dlr_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1email/post/callbacks/dlr_callback/get/responses"}]},"pointer":"/paths/~1email/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/dlrCallbackConfig}","summary":"DLR Notification","operationId":"emailDlrCallbackConfig","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, please contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"transactionType\": \"%tr\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"transactionType\": \"%tr\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"email-messaging/sendemail/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/email-messaging/sendemail#email-messaging/sendemail/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback_config","callbackId":"dlr_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23","pointer":"/paths/~1email/post/callbacks/dlr_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1email/post/callbacks/dlr_callback_config/post/responses"}]},"pointer":"/paths/~1email/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"dlr_callback_config/post","path":"{$request.body#/dlrCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_23"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-messaging/sendemail"}],"panels":[]}]},"httpPath":"/email"}],"content":{"contentType":"group","meta":{"name":"Email Messaging"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Messaging","showPageActions":true},{"nodeType":"markdoc","content":"This allows you to send an email message to a single mobile number per request with option to include one or more file attachments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/email","summary":"Send email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-messaging/sendemail","deprecated":false}]}]}]}]}},{"type":"separator","label":"Business Calls","content":null},{"type":"group","label":"Viber Business Calls","link":"/api/viber-business-calls","routeSlug":"/api/viber-business-calls","items":[],"content":{"contentType":"group","meta":{"name":"Viber Business Calls"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Viber Business Calls","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to receive inbound Viber calls via your PBX system after account activation. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To activate, contact your Account Manager at sales@promotexter.com."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/viber-business-calls"}],"panels":[]}]}},{"type":"separator","label":"Authentication Services","content":null},{"type":"group","label":"SMS Verify","link":"/api/sms-verify","routeSlug":"/api/sms-verify","items":[{"label":"Generate and send verification code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-verify/generatetwofactorcode","routeSlug":"/api/sms-verify/generatetwofactorcode","metadata":{"seo":{"title":"Generate and send verification code","description":"Generates a one-time verification code and sends it via SMS using the required sender ID, recipient and text fields, and optionally include code format customization, expiration, attemptLimit, callback and reference ID fields.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateTwoFactorCode","name":"Generate and send verification code","isWebhook":false,"pointer":"/paths/~1twofa~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate and send verification code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a one-time verification code and sends it via SMS using the required sender ID, recipient and text fields, and optionally include code format customization, expiration, attemptLimit, callback and reference ID fields."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendTwoFactorGenerateRequest","exampleIds":["paths/~1twofa~1generate/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SendTwoFactorGenerateRequest","exampleIds":["paths/~1twofa~1generate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1twofa~1generate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twofa/generate","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SendTwoFactorGenerateRequest","exampleIds":["paths/~1twofa~1generate/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","422"],"pointer":"/twofa/generate","href":"sms-verify/generatetwofactorcode","openApiOperationId":"generateTwoFactorCode","summary":"Generate and send verification code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/SendTwoFactorGenerateRequest","exampleIds":["paths/~1twofa~1generate/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendTwoFactorGenerateRequest","exampleIds":["paths/~1twofa~1generate/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing two-factor transaction details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenerateTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1generate/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/GenerateTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1generate/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1twofa~1generate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenerateTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1generate/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenerateTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1generate/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/dlrCallback}","summary":"[Legacy] DLR Notification","operationId":"twoFactorDlrCallback","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the sender ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&referenceId=%r&date=%d&from=%f&to=%t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sms-verify/generatetwofactorcode/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/sms-verify/generatetwofactorcode#sms-verify/generatetwofactorcode/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your DLR callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback","callbackId":"dlr_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/statuscodes#sms-status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},{"name":"date","in":"query","schemaId":"schema_13","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"referenceId","in":"query","schemaId":"schema_13","description":"Reference ID provided in the original request.","example":"TXN-001"},{"name":"from","in":"query","schemaId":"schema_13","description":"SMS sender ID.","example":"PTXTrial"},{"name":"to","in":"query","schemaId":"schema_13","description":"Recipient mobile number.","example":"639123456789"}],"pointer":"/paths/~1twofa~1generate/post/callbacks/dlr_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1twofa~1generate/post/callbacks/dlr_callback/get/responses"}]},"pointer":"/paths/~1twofa~1generate/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/dlrCallbackConfig}","summary":"DLR Notification","operationId":"twoFactorDlrCallbackConfig","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the sender ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"date\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"date\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sms-verify/generatetwofactorcode/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/sms-verify/generatetwofactorcode#sms-verify/generatetwofactorcode/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback_config","callbackId":"dlr_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1twofa~1generate/post/callbacks/dlr_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1twofa~1generate/post/callbacks/dlr_callback_config/post/responses"}]},"pointer":"/paths/~1twofa~1generate/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"dlr_callback_config/post","path":"{$request.body#/dlrCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-verify/generatetwofactorcode"}],"panels":[]}]},"httpPath":"/twofa/generate"},{"label":"Verify generated code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-verify/verifytwofactorcode","routeSlug":"/api/sms-verify/verifytwofactorcode","metadata":{"seo":{"title":"Verify generated code","description":"Verifies the generated one-time verification code using the required id and code fields.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyTwoFactorCode","name":"Verify generated code","isWebhook":false,"pointer":"/paths/~1twofa~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify generated code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies the generated one-time verification code using the required id and code fields."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerifyTwoFactorCodeRequest","exampleIds":["paths/~1twofa~1verify/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/VerifyTwoFactorCodeRequest","exampleIds":["paths/~1twofa~1verify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1twofa~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twofa/verify","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/VerifyTwoFactorCodeRequest","exampleIds":["paths/~1twofa~1verify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","422"],"pointer":"/twofa/verify","href":"sms-verify/verifytwofactorcode","openApiOperationId":"verifyTwoFactorCode","summary":"Verify generated code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/VerifyTwoFactorCodeRequest","exampleIds":["paths/~1twofa~1verify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerifyTwoFactorCodeRequest","exampleIds":["paths/~1twofa~1verify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing verification result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1verify/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/VerifyTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1verify/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1twofa~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerifyTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1verify/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyTwoFactorCodeResponse","exampleIds":["paths/~1twofa~1verify/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-verify/verifytwofactorcode"}],"panels":[]}]},"httpPath":"/twofa/verify"}],"content":{"contentType":"group","meta":{"name":"SMS Verify"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SMS Verify","showPageActions":true},{"nodeType":"markdoc","content":"This allows you to generate a one-time verification code delivered via SMS and verify the generated code for authentication, allowing seamless authentication flows within Promotexter's platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/twofa/generate","summary":"Generate and send verification code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sms-verify/generatetwofactorcode","deprecated":false},{"title":"/twofa/verify","summary":"Verify generated code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sms-verify/verifytwofactorcode","deprecated":false}]}]}]}]}},{"type":"group","label":"Viber Verification Messages","link":"/api/viber-verification-messages","routeSlug":"/api/viber-verification-messages","items":[{"label":"Send Viber verification messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/viber-verification-messages/sendviberverification","routeSlug":"/api/viber-verification-messages/sendviberverification","metadata":{"seo":{"title":"Send Viber verification messages","description":"Send a pre-approved Viber verification message template by choosing a template below and by using the required Viber channel ID, recipient, and template fields, and optionally including SMS fallback, ttl, callback, and reference ID fields.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendViberVerification","name":"Send Viber verification messages","isWebhook":false,"pointer":"/paths/~1viber~1send‌/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Viber verification messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a pre-approved Viber verification message template by choosing a template below and by using the required Viber channel ID, recipient, and template fields, and optionally including SMS fallback, ttl, callback, and reference ID fields."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ViberOtpRequest"}},"schemaId":"components/schemas/ViberOtpRequest","pointer":"/paths/~1viber~1send‌/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/viber/send‌","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ViberOtpRequest"}},"responseCodes":["200","400","401","422"],"pointer":"/viber/send‌","href":"viber-verification-messages/sendviberverification","openApiOperationId":"sendViberVerification","summary":"Send Viber verification messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/ViberOtpRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ViberOtpRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send‌/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send‌/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1viber~1send‌/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send‌/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ViberResponse","exampleIds":["paths/~1viber~1send‌/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/dlrCallback}","summary":"[Legacy] DLR Notification","operationId":"viberDlrCallback","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Only one DLR notification will be sent per request, even if the transaction falls back to SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Certain transaction-related errors may also be returned through this callback."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the Viber ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, please contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&referenceId=%r&timestamp=%d&from=%f&transactionType=%tr&to=%t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-verification-messages/sendviberverification/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/viber-verification-messages/sendviberverification#viber-verification-messages/sendviberverification/callbacks/dlr_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your DLR callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback","callbackId":"dlr_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"referenceId","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference ID provided in the original request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"TXN-001"},{"name":"transactionType","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"viber"},{"name":"from","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber channel ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"10001"},{"name":"to","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"639123456789"},{"name":"mobileNumber","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"639123456789"},{"name":"errorCode","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code associated with the transaction-related error. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"200236"}],"pointer":"/paths/~1viber~1send‌/post/callbacks/dlr_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send‌/post/callbacks/dlr_callback/get/responses"}]},"pointer":"/paths/~1viber~1send‌/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"get","pathName":"{$request.body#/eventCallback}","summary":"[Legacy] Event Notification","operationId":"viberEventCallback","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event notifications can be sent through a GET request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Event notification is only applicable to transactions delivered via Viber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your callback URL may contain the following placeholder values, see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for event status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the event is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobileNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example event callback URL with placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?status=%s&id=%i&timestamp=%d&to=%t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example event callback URL without placeholders:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-verification-messages/sendviberverification/callbacks/event_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url","deepLinkHash":"/viber-verification-messages/sendviberverification#viber-verification-messages/sendviberverification/callbacks/event_callback/get/the-following-data-will-be-appended-as-query-parameters-to-your-configured-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following data will be appended as query parameters to your configured URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your event callback URL, some query parameters are appended with an underscore, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"event_callback","callbackId":"event_callback/get","contentChildren":[{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_13","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},{"name":"status","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Event status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8000"},{"name":"timestamp","in":"query","schemaId":"schema_13","description":"Date and time the event is received (UTC).","example":"2026-05-25T07:41:09.031Z"},{"name":"mobileNumber","in":"query","schemaId":"schema_13","description":"Recipient mobile number.","example":"639123456789"}],"pointer":"/paths/~1viber~1send‌/post/callbacks/event_callback/get/parameters"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send‌/post/callbacks/event_callback/get/responses"}]},"pointer":"/paths/~1viber~1send‌/post/callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/dlrCallbackConfig}","summary":"DLR Notification","operationId":"viberDlrCallbackConfig","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Only one DLR notification will be sent per request, even if the transaction falls back to SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Certain transaction-related errors may also be returned through this callback."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for DLR status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the DLR is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the Viber ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An option to add the transaction type to your DLR notification without including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder is available. To activate this, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example DLR callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"transactionType\": \"%tr\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"dlrCallbackConfig\": {\n  \"url\": \"https://your-server.com/callback\",\n  \"headers\": {\n    \"X-Custom-Header\": \"test-value\"\n  },\n  \"body\": {\n    \"id\": \"%i\",\n    \"status\": \"%s\",\n    \"timestamp\": \"%d\",\n    \"referenceId\": \"%r\",\n    \"transactionType\": \"%tr\",\n    \"from\": \"%f\",\n    \"to\": \"%t\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-verification-messages/sendviberverification/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/viber-verification-messages/sendviberverification#viber-verification-messages/sendviberverification/callbacks/dlr_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"dlr_callback_config","callbackId":"dlr_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25","pointer":"/paths/~1viber~1send‌/post/callbacks/dlr_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send‌/post/callbacks/dlr_callback_config/post/responses"}]},"pointer":"/paths/~1viber~1send‌/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"dlr_callback_config/post","path":"{$request.body#/dlrCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/eventCallbackConfig}","summary":"Event Notification","operationId":"viberEventCallbackConfig","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event notifications can be sent through a POST request to the callback URL specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCallbackConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Event notification is only applicable to transactions delivered via Viber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also customize the JSON body of your POST callback using the following placeholder values, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for event status code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the event is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobileNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient's mobile number"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example event callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  \"eventCallbackConfig\": {\n    \"url\": \"https://your-server.com/callback\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"id\": \"%i\",\n      \"status\": \"%s\",\n      \"timestamp\": \"%d\",\n      \"mobileNumber\": \"%t\"\n    }\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  \"eventCallbackConfig\": {\n    \"url\": \"https://your-server.com/callback\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"id\": \"%i\",\n      \"status\": \"%s\",\n      \"timestamp\": \"%d\",\n      \"mobileNumber\": \"%t\"\n    }\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"viber-verification-messages/sendviberverification/callbacks/event_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/viber-verification-messages/sendviberverification#viber-verification-messages/sendviberverification/callbacks/event_callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"event_callback_config","callbackId":"event_callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16","pointer":"/paths/~1viber~1send‌/post/callbacks/event_callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1viber~1send‌/post/callbacks/event_callback_config/post/responses"}]},"pointer":"/paths/~1viber~1send‌/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"event_callback_config/post","path":"{$request.body#/eventCallbackConfig}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/viber-verification-messages/sendviberverification"}],"panels":[]}]},"httpPath":"/viber/send‌"}],"content":{"contentType":"group","meta":{"name":"Viber Verification Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Viber Verification Messages","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to send templated Viber verification messages (OTPs) for authentication. You can select from 9 pre-approved Viber templates below, which can also be translated into multiple languages. See available template languages "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It also supports optional SMS fallback for undelivered messages. SMS fallback content is not restricted to the Viber verification messages templates and can be fully customized with your own text."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/viber/send‌","summary":"Send Viber verification messages","prefix":{"name":"post","color":"post"},"badges":[],"link":"/viber-verification-messages/sendviberverification","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Authentication","link":"/api/whatsapp-authentication","routeSlug":"/api/whatsapp-authentication","items":[{"label":"Send WhatsApp authentication messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/whatsapp-authentication/sendwhatsappauthentication","routeSlug":"/api/whatsapp-authentication/sendwhatsappauthentication","metadata":{"seo":{"title":"Send WhatsApp authentication messages","description":"Send a WhatsApp authentication template message using Meta-compatible payload structure and optionally enables SMS fallback when WhatsApp delivery fails. WhatsApp template content is not automatically reused for SMS delivery, please define your SMS fallback message wording per request.Note: The below WhatsApp error codes will trigger SMS fallback when the required SMS fallback parameters are included in the request.131026 - Unable to deliver message. Reasons can include the recipient not being a WhatsApp user, not having accepted the latest Terms of Service and Privacy Policy, or using an outdated WhatsApp version.131062 - Business-scoped User ID (BSUID) recipients are not supported for this message.See WhatsApp error codes.Authentication options: either use a Promotexter token in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the API Authentication section for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendWhatsAppAuthentication","name":"Send WhatsApp authentication messages","isWebhook":false,"pointer":"/paths/~1whatsapp~1send‌/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send WhatsApp authentication messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a WhatsApp authentication template message using Meta-compatible payload structure and optionally enables SMS fallback when WhatsApp delivery fails. WhatsApp template content is not automatically reused for SMS delivery, please define your SMS fallback message wording per request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The below WhatsApp error codes will trigger SMS fallback when the required SMS fallback parameters are included in the request."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ol","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131026"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unable to deliver message. Reasons can include the recipient not being a WhatsApp user, not having accepted the latest Terms of Service and Privacy Policy, or using an outdated WhatsApp version."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"131062"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Business-scoped User ID (BSUID) recipients are not supported for this message."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/support/error-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp error codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either use a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization header, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/api/api-authentication","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendWhatsAppAuthenticationRequest"}},"schemaId":"components/schemas/SendWhatsAppAuthenticationRequest","pointer":"/paths/~1whatsapp~1send‌/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/whatsapp/send‌","servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SendWhatsAppAuthenticationRequest"}},"responseCodes":["200","400","401","422"],"pointer":"/whatsapp/send‌","href":"whatsapp-authentication/sendwhatsappauthentication","openApiOperationId":"sendWhatsAppAuthentication","summary":"Send WhatsApp authentication messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api","description":"Mock server","isMockServer":true},{"url":"https://api.promotexter.com"}],"schemaId":"components/schemas/SendWhatsAppAuthenticationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendWhatsAppAuthenticationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send‌/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send‌/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized Access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"422","description":"Parameters validation error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}},"schemaId":"components/schemas/ContentParamValidationError"}],"pointer":"/paths/~1whatsapp~1send‌/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send‌/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsAppResponse","exampleIds":["paths/~1whatsapp~1send‌/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"422","schemaId":"components/schemas/ContentParamValidationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ContentParamValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/callbackConfig/url}","summary":"DLR and Event Notifications","operationId":"whatsappAuthenticationCallbackConfigInline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR and event notifications are sent through a POST request to the callback URL specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callbackConfig.url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only one DLR notification will be sent per request, even if the transaction falls back to SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Certain transaction-related errors may also be returned through this callback. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can add safelisted custom headers. To safelist your headers, contact support@promotexter.com."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use the following placeholders in your callback request body, see below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%s"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for callback status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%i"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the transaction ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%r"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the reference ID if it has value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%d"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the date and time the callback is received (UTC)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp sender phone number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%tr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the type of channel to which the transaction is delivered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%t"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient mobile number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%bsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient BSUID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%pbsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parentBsuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the recipient parent BSUID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%p"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp contacts object returned by WhatsApp as-is."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%pc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricingCategory"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp pricing category returned by WhatsApp as-is."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%pt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricingType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the WhatsApp pricing type returned by WhatsApp as-is."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%mo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"marketingOptimized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder for the marketing optimized marker."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example callback configuration with custom headers and JSON body with placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  \"callbackConfig\": {\n    \"url\": \"https://example.com\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"status\": \"%s\",\n      \"id\": \"%i\",\n      \"referenceId\": \"%r\",\n      \"timestamp\": \"%d\",\n      \"from\": \"%f\",\n      \"transactionType\": \"%tr\",\n      \"to\": \"%t\",\n      \"bsuid\": \"%bsuid\",\n      \"parentBsuid\": \"%pbsuid\",\n      \"contacts\": \"%p\",\n      \"pricingCategory\": \"%pc\",\n      \"pricingType\": \"%pt\",\n      \"marketingOptimized\": \"%mo\"\n    }\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  \"callbackConfig\": {\n    \"url\": \"https://example.com\",\n    \"headers\": {\n      \"X-Custom-Header\": \"test-value\"\n    },\n    \"body\": {\n      \"status\": \"%s\",\n      \"id\": \"%i\",\n      \"referenceId\": \"%r\",\n      \"timestamp\": \"%d\",\n      \"from\": \"%f\",\n      \"transactionType\": \"%tr\",\n      \"to\": \"%t\",\n      \"bsuid\": \"%bsuid\",\n      \"parentBsuid\": \"%pbsuid\",\n      \"contacts\": \"%p\",\n      \"pricingCategory\": \"%pc\",\n      \"pricingType\": \"%pt\",\n      \"marketingOptimized\": \"%mo\"\n    }\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"whatsapp-authentication/sendwhatsappauthentication/callbacks/callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url.","deepLinkHash":"/whatsapp-authentication/sendwhatsappauthentication#whatsapp-authentication/sendwhatsappauthentication/callbacks/callback_config/post/the-following-json-payload-will-be-sent-to-your-configured-url."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following JSON payload will be sent to your configured URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you do not use placeholders in your JSON body, some parameters are appended with an underscore in your JSON payload, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_transactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_bsuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_parentBsuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_contacts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_pricingCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_pricingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_marketingOptimized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"callback_config","callbackId":"callback_config/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsAppCallbackPayload"}},"schemaId":"components/schemas/WhatsAppCallbackPayload","pointer":"/paths/~1whatsapp~1send‌/post/callbacks/callback_config/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned by your server when the callback is accepted."}],"pointer":"/paths/~1whatsapp~1send‌/post/callbacks/callback_config/post/responses"}]},"pointer":"/paths/~1whatsapp~1send‌/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"callback_config/post","path":"{$request.body#/callbackConfig/url}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-authentication/sendwhatsappauthentication"}],"panels":[]}]},"httpPath":"/whatsapp/send‌"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Authentication","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to send WhatsApp authentication template messages to a single mobile number per request with fallback to SMS as an option if the recipient cannot be reached via WhatsApp within the message lifetime. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/whatsapp/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API for authentication messages utilizes Meta's WhatsApp Cloud API."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/whatsapp/send‌","summary":"Send WhatsApp authentication messages","prefix":{"name":"post","color":"post"},"badges":[],"link":"/whatsapp-authentication/sendwhatsappauthentication","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/GeneratePromotexterTokenRequest":{"id":"components/schemas/GeneratePromotexterTokenRequest","kind":"json-schema","title":"GeneratePromotexterTokenRequest","data":{"type":"object","properties":{"expiresInSeconds":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration of the Promotexter token in seconds. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Min: 1 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max: 3600"},"children":[]}]}]}],"example":3600}},"required":["expiresInSeconds"]}},"components/schemas/GeneratePromotexterTokenResponse":{"id":"components/schemas/GeneratePromotexterTokenResponse","kind":"json-schema","title":"GeneratePromotexterTokenResponse","data":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"data":{"type":"string","description":"Promotexter token, usable for all API requests until expiry.","example":"eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJwcm9tb3RleHRlci1hcGkiLCJzdWIiOiJ1c2VyLTEyMzQ1IiwiaWF0IjoxNzI0Njk5MDAwLCJleHAiOjE3MjQ3MDI2MDB9.Nk9vZ0RrQ2lMZ3J4V2hXQ1VnU1lRZ2tVQ2p2R0xZbFJfN3hWQ1M5M1F4Q2lCd2hSQ3dZVnVqS0h2Y1J0T1lFQmVxS2VxR0ZkWnV5R2w"}},"required":["status","data"]}},"components/schemas/getAccountBalanceResponse":{"id":"components/schemas/getAccountBalanceResponse","kind":"json-schema","title":"getAccountBalanceResponse","data":{"type":"object","properties":{"availableBalance":{"type":"number","example":905.57},"accountBalance":{"type":"number","example":-9096.95},"creditLimit":{"type":"number","example":10000},"withheld":{"type":"number","example":-2.52}}}},"components/schemas/ViberGlobalAuthOptionalBodyCredsParams":{"id":"components/schemas/ViberGlobalAuthOptionalBodyCredsParams","kind":"json-schema","title":"Global Viber Parameters","data":{"title":"Global Viber Parameters","type":"object","properties":{"apiKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},"apiSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your Viber channel ID. This would appear as the sender of the Viber message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"10001"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient of the message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid mobile number."},"children":[]}]}]}],"example":"639123456789"}},"required":["to","from"]}},"components/schemas/ViberGlobalOptionalParams":{"id":"components/schemas/ViberGlobalOptionalParams","kind":"json-schema","title":"Global Viber Parameters","data":{"title":"Global Viber Parameters","type":"object","properties":{"ttl":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message lifetime value in seconds."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Min: 7 (recommended only for OTP transactions.) "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max: 259200 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default for non-template transactions: 259200 or 14 days "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default for templated transactions: 7"},"children":[]}]}]}],"example":86400},"dlrCallback":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Legacy] Your own API endpoint where DLR notifications will be sent via the GET method."},"children":[]}]}]}],"example":"https://example.com"},"eventCallback":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Legacy] Your own API endpoint where event notifications will be sent via the GET method."},"children":[]}]}]}],"example":"https://example.com"},"dlrCallbackConfig":{"type":"object","description":"Configuration for receiving DLR notifications via the POST method.","example":{"url":"https://example.com","headers":{},"body":{}},"properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own API endpoint where DLR notifications will be sent. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com"},"children":[]}]}]}],"example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}],"example":{"X-Custom-Header":"test-value"}},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR Notification POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/sendViber/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}],"example":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}}},"required":["url"]},"eventCallbackConfig":{"type":"object","description":"Configuration for receiving event notifications via the POST method.","example":{"url":"https://example.com","headers":{},"body":{}},"properties":{"url":{"type":"string","description":"Your own API endpoint where event notifications will be sent.","example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}],"example":{"X-Custom-Header":"test-value"}},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Notification POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/sendViber/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}],"example":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}}},"required":["url"]},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference ID to the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 60 characters."},"children":[]}]}]}],"example":"TXN-20260514-0001"},"sms_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your SMS sender name. This would appear as the sender of the SMS message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"Test Sender"},"sms_text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS Fallback message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 10-message parts (1530 standard-GSM or 670 Unicode characters)."},"children":[]}]}]}],"example":"This is a sample SMS message."}}}},"components/schemas/ViberTextRequest":{"id":"components/schemas/ViberTextRequest","kind":"json-schema","title":"Text-only","data":{"title":"Text-only","description":"Defines the content of a promotional text-only Viber message.","type":"object","properties":{"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 1000 characters."},"children":[]}]}]}],"example":"This is a sample Viber message."}},"required":["text"]}},"components/schemas/ViberTextButtonRequest":{"id":"components/schemas/ViberTextButtonRequest","kind":"json-schema","title":"Text + Button","data":{"title":"Text + Button","description":"Defines the content of a Viber text message with a call-to-action button.","type":"object","properties":{"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 1000 characters."},"children":[]}]}]}],"example":"This is a sample Viber message."},"caption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call-to-action button label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 30 characters."},"children":[]}]}]}],"example":"Click me"},"url":{"type":"string","description":"Call-to-action button URL.","example":"https://examplectaurl.com"}},"required":["text","caption","url"]}},"components/schemas/ViberImageRequest":{"id":"components/schemas/ViberImageRequest","kind":"json-schema","title":"Image","data":{"title":"Image","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the content of a Viber message with image content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Allowed message combinations are: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Image only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Text + image "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Image + CTA button "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Text + Image + CTA button "},"children":[]}]}]}]}],"type":"object","properties":{"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 1000 characters."},"children":[]}]}]}],"example":"This is a sample Viber message."},"image":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the Viber image content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Recommended resolution: 400x400px "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported formats: .jpg, jpeg, .png"},"children":[]}]}]}],"example":"https://exampleimageurl.com"},"caption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call-to-action button label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 30 characters."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: This parameter is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is provided."},"children":[]}]}]}],"example":"Click me"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call-to-action button URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: This parameter is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is provided."},"children":[]}]}]}],"example":"https://examplectaurl.com"}},"required":["image"]}},"components/schemas/ViberVideoRequest":{"id":"components/schemas/ViberVideoRequest","kind":"json-schema","title":"Video","data":{"title":"Video","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the content of a Viber message with video content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Allowed message combinations are: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Video only "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Text + video "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Video + CTA button "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Text + Video + CTA button "},"children":[]}]}]}]}],"type":"object","properties":{"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 1000 characters."},"children":[]}]}]}],"example":"This is a sample Viber message."},"thumbnail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the Viber video thumbnail."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Recommended resolution: 400x400px "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported formats: .jpg, jpeg, .png "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note:This parameter is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is provided."},"children":[]}]}]}],"example":"https://examplethumbnailurl.com"},"video":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the Viber video content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max size: 200 MB "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max duration: 600 seconds "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported formats: .3gp, .mpv, .m4v, .mov, .mp4"},"children":[]}]}]}],"example":"https://examplevideourl.com"},"caption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call-to-action button label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 30 characters."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: This parameter is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is provided."},"children":[]}]}]}],"example":"Click me"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call-to-action button URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: This parameter is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is provided."},"children":[]}]}]}],"example":"https://examplectaurl.com"}},"required":["thumbnail","video"]}},"components/schemas/ViberOtpRequest":{"id":"components/schemas/ViberOtpRequest","kind":"json-schema","title":"Verification Messages","data":{"title":"Verification Messages","description":"Defines the content of a templated OTP Viber message. This message type uses pre-approved Viber templates, please choose below.","anyOf":[{"title":"Basic OTP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your code is {{pin}}. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"type":"object","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"0aac888f-2ee2-4112-9659-1755a951966a","templateParams":{"pin":"12345"},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0001","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"0aac888f-2ee2-4112-9659-1755a951966a"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"}},"required":["pin"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Basic OTP valid for 5 minutes","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your code is {{pin}}. It's valid for 5 minutes. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"c2cdc028-a48b-4187-bbaf-3aaa137b6e23","templateParams":{"pin":"12345"},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0002","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"c2cdc028-a48b-4187-bbaf-3aaa137b6e23"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"}},"required":["pin"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"c2cdc028-a48b-4187-bbaf-3aaa137b6e23"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"}},"required":["pin"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"OTP with business/platform name","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{business_platform_name}}: Your code is {{pin}}. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"c33cccaf-735f-4d62-8383-a76bf4999e2d","templateParams":{"pin":"12345","business_platform_name":"ABC Company"},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0003","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"c33cccaf-735f-4d62-8383-a76bf4999e2d"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"business_platform_name":{"type":"string","description":"Template placeholder for the business platform name. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"ABC Company"}},"required":["pin","business_platform_name"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"c33cccaf-735f-4d62-8383-a76bf4999e2d"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"business_platform_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the business platform name. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"ABC Company"}},"required":["pin","business_platform_name"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Basic OTP with code validity time","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your code is {{pin}}. It's valid for {{code_validity_time}} minutes. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"bed0942f-e07e-4879-834b-29cc4cf3ec35","templateParams":{"pin":"12345","code_validity_time":5},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0004","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"bed0942f-e07e-4879-834b-29cc4cf3ec35"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"code_validity_time":{"type":"number","description":"Template placeholder for the code validity time. <br> Up to 50 characters. <br> Only a single number, no space before or after. <br> Links are not allowed.","example":5}},"required":["pin","code_validity_time"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"bed0942f-e07e-4879-834b-29cc4cf3ec35"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"code_validity_time":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the code validity time. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only a single number, no space before or after. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":5}},"required":["pin","code_validity_time"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"OTP with code type & validity time","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your {{pin_type}} code is {{pin}}. It's valid for {{code_validity_time}} minutes. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"60d67b38-b9fb-444a-80e6-754447e010c6","templateParams":{"pin":"12345","pin_type":"authentication code","code_validity_time":5},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0005","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"60d67b38-b9fb-444a-80e6-754447e010c6"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"pin_type":{"type":"string","description":"Template placeholder for PIN type. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"authentication code"},"code_validity_time":{"type":"number","description":"Template placeholder for the code validity time. <br> Up to 50 characters. <br> Only a single number, no space before or after. <br> Links are not allowed.","example":5}},"required":["pin","pin_type","code_validity_time"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"60d67b38-b9fb-444a-80e6-754447e010c6"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"pin_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN type. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"authentication code"},"code_validity_time":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the code validity time. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only a single number, no space before or after. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":5}},"required":["pin","pin_type","code_validity_time"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"OTP with business/platform name & validity time","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your {{business_platform_name}} code is {{pin}}. It's valid for {{code_validity_time}} minutes. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"6c929cef-29b4-4349-bc9d-2a07bdbb6e43","templateParams":{"pin":"12345","business_platform_name":"ABC Wallet","code_validity_time":5},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0006","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"6c929cef-29b4-4349-bc9d-2a07bdbb6e43"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"business_platform_name":{"type":"string","description":"Template placeholder for the business platform name. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"ABC Wallet"},"code_validity_time":{"type":"number","description":"Template placeholder for the code validity time. <br> Up to 50 characters. <br> Only a single number, no space before or after. <br> Links are not allowed.","example":5}},"required":["pin","business_platform_name","code_validity_time"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"6c929cef-29b4-4349-bc9d-2a07bdbb6e43"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"business_platform_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the business platform name. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"ABC Wallet"},"code_validity_time":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the code validity time. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only a single number, no space before or after. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":5}},"required":["pin","business_platform_name","code_validity_time"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"OTP with type of code type","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your {{pin_type}} code is {{pin}}. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"82ba31a3-db42-4e87-82e8-33fa92b9e5ed","templateParams":{"pin":"12345","pin_type":"authentication code"},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0007","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"82ba31a3-db42-4e87-82e8-33fa92b9e5ed"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"pin_type":{"type":"string","description":"Template placeholder for PIN type. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"authentication code"}},"required":["pin","pin_type"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"82ba31a3-db42-4e87-82e8-33fa92b9e5ed"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"pin_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN type. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"authentication code"}},"required":["pin","pin_type"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"OTP with details on OTP action/platform","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Your one-time password for {{business_platform_action_name}} is {{pin}}. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"210ee8a9-1ed5-43cd-96e4-65bba311ab40","templateParams":{"pin":"12345","business_platform_action_name":"Login Verification"},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0008","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"210ee8a9-1ed5-43cd-96e4-65bba311ab40"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"business_platform_action_name":{"type":"string","description":"Template placeholder for the business platform action name. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"Login Verification"}},"required":["pin","business_platform_action_name"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"210ee8a9-1ed5-43cd-96e4-65bba311ab40"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"business_platform_action_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the business platform action name. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"Login Verification"}},"required":["pin","business_platform_action_name"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"OTP with business/platform name & code reason","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" English copy:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{business_platform_name}}: Your code is {{pin}}. You got this code because {{code_reason}}. Please don't share your code with ANYONE. We'll never call or message you and ask for it."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: SMS fallback message is customizable and is not part of the predefined Viber verification message template. You may define your own SMS fallback message wording."},"children":[]}]}]}],"example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"be56d97b-2a33-4c89-ac5f-f555a2c827d9","templateParams":{"pin":"12345","business_platform_name":"ABC Wallet","code_reason":"of your login attempt."},"templateLang":"en","targetDevice":"primary","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"eventCallbackConfig":{"url":"https://example.com","headers":{},"body":{}},"referenceId":"VIBER-2FA-20260909-0009","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"x-viber-otp-properties":{"templateId":{"type":"string","description":"Unique ID of the template. <br> Must be a valid template ID based on available Viber OTP templates.<br> The value provided below is an actual template ID of this template and should be used as-is.","example":"be56d97b-2a33-4c89-ac5f-f555a2c827d9"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":"Template placeholder for PIN. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"12345"},"business_platform_name":{"type":"string","description":"Template placeholder for the business platform name. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"ABC Wallet"},"code_reason":{"type":"string","description":"Template placeholder for the code reason. <br> Up to 50 characters. <br> Space, numbers and special characters are allowed. <br> Links are not allowed.","example":"of your login attempt."}},"required":["pin","business_platform_name","code_reason"]},"templateLang":{"type":"string","description":"Defines the language of the OTP message.<br> See References > Other Resources > <a href=\"https://promotexter-api.redocly.app/viberlang\" target=\"_blank\" rel=\"noopener noreferrer\">Viber Template Languages</a> for the full list.","example":"en"},"targetDevice":{"type":"string","description":"Defines the device delivery scope. <br> If set to `primary`, the message is sent only to the user's primary device. <br> If set to `all`, the message is sent to all the user's devices. <br> Default: `primary`.","example":"primary"}},"required":["templateId","templateParams"],"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value provided below is an actual template ID of this template and should be used as-is."},"children":[]}]}]}],"example":"be56d97b-2a33-4c89-ac5f-f555a2c827d9"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"},"business_platform_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the business platform name. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"ABC Wallet"},"code_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for the code reason. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"of your login attempt."}},"required":["pin","business_platform_name","code_reason"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"primary"}},"required":["templateId","templateParams"]},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]}]}},"components/schemas/ViberOtpSimpleRequest":{"id":"components/schemas/ViberOtpSimpleRequest","kind":"json-schema","title":"OTP","data":{"title":"OTP","description":"Defines the content of a templated OTP Viber message without template-variant selection.","type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the OTP template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID based on available Viber OTP templates."},"children":[]}]}]}],"example":"8b7f2c19-4e35-4d21-b6d8-9f1a7c3e5b62"},"templateParams":{"type":"object","description":"Contains the dynamic variables required for the selected OTP template.","properties":{"pin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template placeholder for PIN. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 50 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Space, numbers and special characters are allowed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Links are not allowed."},"children":[]}]}]}],"example":"12345"}},"required":["pin"]},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language of the OTP message."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"all"}},"required":["templateId","templateParams"]}},"components/schemas/ViberTransactionalRequest":{"id":"components/schemas/ViberTransactionalRequest","kind":"json-schema","title":"Transactional Templates","data":{"title":"Transactional Templates","description":"Defines the content of a custom, pre-approved text-only transactional Viber template.","type":"object","properties":{"templateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the transactional template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid template ID that has been submitted and approved for your account."},"children":[]}]}]}],"example":"3be6a2f1-8d9c-4b57-a1e3-7f20c9d64b15"},"templateParams":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the dynamic variables required for the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only if the template has parameters."},"children":[]}]}]}],"example":{"order_id":"ORD-20260805-1042","delivery_status":"Packed and ready for dispatch"}},"templateLang":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the language code of the template. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value must be a valid language code and must match the language set during template submission. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See References > Other Resources > "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/viberlang","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber Template Languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"en"},"targetDevice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the device delivery scope. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent only to the user's primary device. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message is sent to all the user's devices. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"all"}},"required":["templateId","templateLang"]}},"components/schemas/ViberResponse":{"id":"components/schemas/ViberResponse","kind":"json-schema","title":"Viber API Response","data":{"title":"Viber API Response","type":"object","properties":{"transactionId":{"type":"string","example":"aab7faa4-cf35-4931-84d4-2c98cfc935dc"},"requestId":{"type":"string","example":"4c300362-d3f9-402d-8c80-af0bd10daacb"}},"required":["transactionId","requestId"]}},"components/schemas/SendWhatsAppRequest":{"id":"components/schemas/SendWhatsAppRequest","kind":"json-schema","title":"SendWhatsAppRequest","data":{"description":"Defines the content for sending template message types such as Marketing, Authentication and Utility.","oneOf":[{"$ref":"#/components/schemas/SendWhatsAppTemplateRequest"},{"$ref":"#/components/schemas/SendWhatsAppAudioRequest"},{"$ref":"#/components/schemas/SendWhatsAppContactsRequest"},{"$ref":"#/components/schemas/SendWhatsAppDocumentRequest"},{"$ref":"#/components/schemas/SendWhatsAppImageRequest"},{"$ref":"#/components/schemas/SendWhatsAppInteractiveRequest"},{"$ref":"#/components/schemas/SendWhatsAppLocationRequest"},{"$ref":"#/components/schemas/SendWhatsAppLocationRequestMessageRequest"},{"$ref":"#/components/schemas/SendWhatsAppReactionRequest"},{"$ref":"#/components/schemas/SendWhatsAppStickerRequest"},{"$ref":"#/components/schemas/SendWhatsAppTextRequest"},{"$ref":"#/components/schemas/SendWhatsAppVideoRequest"}]}},"components/schemas/SendWhatsAppAuthenticationRequest":{"id":"components/schemas/SendWhatsAppAuthenticationRequest","kind":"json-schema","title":"Authentication Template","data":{"title":"Authentication Template","description":"Defines the content for sending WhatsApp authentication template messages.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"template\""},"children":[]}]}]}],"example":"template"},"template":{"type":"object","description":"Authentication template message object. Use Meta's template payload structure.","additionalProperties":true}},"required":["from","type","template"]},{"$ref":"#/components/schemas/SendWhatsAppAuthenticationRequestTail"}]}},"components/schemas/SendWhatsAppAuthenticationRequestTail":{"id":"components/schemas/SendWhatsAppAuthenticationRequestTail","kind":"json-schema","title":"WhatsApp Authentication Optional Parameters","data":{"title":"WhatsApp Authentication Optional Parameters","type":"object","properties":{"sms_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your SMS sender name. This would appear as the sender of the SMS message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"TESTSMS"},"sms_text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS Fallback message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 10-message parts (1530 standard-GSM or 670 Unicode characters)."},"children":[]}]}]}],"example":"This is a WhatsApp fallback message"},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference ID to the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 60 characters."},"children":[]}]}]}],"example":"referenceId_123"},"callbackConfig":{"type":"object","description":"Configuration for receiving DLR and event notifications via the POST method.","example":{"url":"https://example.com","headers":{},"body":{}},"properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own API endpoint where DLR and event notifications will be sent. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com"},"children":[]}]}]}],"example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}],"example":{"X-Custom-Header":"test-value"}},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR and Event Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/api/whatsapp-authentication#operation/sendWhatsAppAuthentication/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}],"example":{"status":"%s","id":"%i","referenceId":"%r","timestamp":"%d","from":"%f","transactionType":"%tr","to":"%t","bsuid":"%bsuid","parentBsuid":"%pbsuid","contacts":"%p","pricingCategory":"%pc","pricingType":"%pt","marketingOptimized":"%mo"}}},"required":["url"]}}}},"components/schemas/SendWhatsAppRequestHead":{"id":"components/schemas/SendWhatsAppRequestHead","kind":"json-schema","title":"WhatsApp Common Parameters","data":{"title":"WhatsApp Common Parameters","type":"object","properties":{"apiKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},"apiSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your WhatsApp sender phone number. This would appear as the sender of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted in your account."},"children":[]}]}]}],"example":"15554443332"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required when using SMS fallback or authentication templates."},"children":[]}]}]}],"example":"639123456789"},"recipient":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient BSUID or parent BSUID. Learn more about BSUID "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/business-scoped-user-ids/","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SMS fallback is not allowed when using this field."},"children":[]}]}]}],"example":"PH.1234567891011121"}}}},"components/schemas/SendWhatsAppRequestTail":{"id":"components/schemas/SendWhatsAppRequestTail","kind":"json-schema","title":"WhatsApp Optional Parameters","data":{"title":"WhatsApp Optional Parameters","type":"object","properties":{"sms_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your SMS sender name. This would appear as the sender of the SMS message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"TESTSMS"},"sms_text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS Fallback message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 10-message parts (1530 standard-GSM or 670 Unicode characters)."},"children":[]}]}]}],"example":"This is a WhatsApp fallback message"},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference ID to the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 60 characters."},"children":[]}]}]}],"example":"referenceId_123"},"callbackConfig":{"type":"object","description":"Configuration for receiving DLR and event notifications via the POST method.","example":{"url":"https://example.com","headers":{},"body":{}},"properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own API endpoint where DLR and event notifications will be sent. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com"},"children":[]}]}]}],"example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}],"example":{"X-Custom-Header":"test-value"}},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR and Event Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/sendWhatsApp/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}],"example":{"status":"%s","id":"%i","referenceId":"%r","timestamp":"%d","from":"%f","transactionType":"%tr","to":"%t","bsuid":"%bsuid","parentBsuid":"%pbsuid","contacts":"%p","pricingCategory":"%pc","pricingType":"%pt","marketingOptimized":"%mo"}}},"required":["url"]}}}},"components/schemas/SendWhatsAppTemplateRequest":{"id":"components/schemas/SendWhatsAppTemplateRequest","kind":"json-schema","title":"Template","data":{"title":"Template","description":"Defines the content for sending template message types such as Marketing, Authentication and Utility.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"template\""},"children":[]}]}]}],"example":"template"},"template":{"type":"object","description":"Template message object. Use Meta's template payload structure. This also depends on the approved template structure and variables defined for the selected template.","additionalProperties":true}},"required":["from","type","template"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppTextRequest":{"id":"components/schemas/SendWhatsAppTextRequest","kind":"json-schema","title":"Text","data":{"title":"Text","description":"Defines the content for sending \"text\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"text\""},"children":[]}]}]}],"example":"text"},"text":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text message object. Use Meta's text payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/text-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","text"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppImageRequest":{"id":"components/schemas/SendWhatsAppImageRequest","kind":"json-schema","title":"Image","data":{"title":"Image","description":"Defines the content for sending \"image\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"image\""},"children":[]}]}]}],"example":"image"},"image":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image message object. Use Meta's image payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/image-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","image"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppAudioRequest":{"id":"components/schemas/SendWhatsAppAudioRequest","kind":"json-schema","title":"Audio","data":{"title":"Audio","description":"Defines the content for sending \"audio\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"audio\""},"children":[]}]}]}],"example":"audio"},"audio":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audio message object. Use Meta's audio payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/audio-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","audio"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppDocumentRequest":{"id":"components/schemas/SendWhatsAppDocumentRequest","kind":"json-schema","title":"Document","data":{"title":"Document","description":"Defines the content for sending \"document\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"document\""},"children":[]}]}]}],"example":"document"},"document":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document message object. Use Meta's document payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/document-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","document"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppVideoRequest":{"id":"components/schemas/SendWhatsAppVideoRequest","kind":"json-schema","title":"Video","data":{"title":"Video","description":"Defines the content for sending \"video\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"video\""},"children":[]}]}]}],"example":"video"},"video":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video message object. Use Meta's video payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/video-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","video"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppStickerRequest":{"id":"components/schemas/SendWhatsAppStickerRequest","kind":"json-schema","title":"Sticker","data":{"title":"Sticker","description":"Defines the content for sending \"sticker\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"sticker\""},"children":[]}]}]}],"example":"sticker"},"sticker":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sticker message object. Use Meta's sticker payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/sticker-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","sticker"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppLocationRequest":{"id":"components/schemas/SendWhatsAppLocationRequest","kind":"json-schema","title":"Location","data":{"title":"Location","description":"Defines the content for sending \"location\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"location\""},"children":[]}]}]}],"example":"location"},"location":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location message object. Use Meta's location payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/location-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","location"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppContactsRequest":{"id":"components/schemas/SendWhatsAppContactsRequest","kind":"json-schema","title":"Contacts","data":{"title":"Contacts","description":"Defines the content for sending \"contacts\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"contacts\""},"children":[]}]}]}],"example":"contacts"},"contacts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts message object list. Use Meta's contacts payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/contacts-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}}},"required":["from","type","contacts"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppInteractiveRequest":{"id":"components/schemas/SendWhatsAppInteractiveRequest","kind":"json-schema","title":"Interactive","data":{"title":"Interactive","description":"Defines the content for sending \"interactive\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"interactive\""},"children":[]}]}]}],"example":"interactive"},"interactive":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interactive message object. Use Meta's interactive payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/interactive-cta-url-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","interactive"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppLocationRequestMessageRequest":{"id":"components/schemas/SendWhatsAppLocationRequestMessageRequest","kind":"json-schema","title":"Location Request","data":{"title":"Location Request","description":"Defines the content for sending \"location request\" message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"interactive\""},"children":[]}]}]}],"example":"interactive"},"interactive":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location request message object. Use Meta's location request payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/location-request-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","interactive"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/SendWhatsAppReactionRequest":{"id":"components/schemas/SendWhatsAppReactionRequest","kind":"json-schema","title":"Reaction","data":{"title":"Reaction","description":"Defines the content for sending \"reaction\" free-form message type.","allOf":[{"$ref":"#/components/schemas/SendWhatsAppRequestHead"},{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: \"reaction\""},"children":[]}]}]}],"example":"reaction"},"reaction":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reaction message object. Use Meta's reaction payload structure. Learn more "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/reaction-messages","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}},"required":["from","type","reaction"]},{"$ref":"#/components/schemas/SendWhatsAppRequestTail"}]}},"components/schemas/WhatsAppResponse":{"id":"components/schemas/WhatsAppResponse","kind":"json-schema","title":"WhatsApp Send Transaction Response","data":{"type":"object","title":"WhatsApp Send Transaction Response","properties":{"transactionId":{"type":"string","example":"aab7faa4-cf35-4931-84d4-2c98cfc935dc"},"requestId":{"type":"string","example":"4c300362-d3f9-402d-8c80-af0bd10daacb"}},"required":["transactionId","requestId"]}},"components/schemas/WhatsAppCallbackPayload":{"id":"components/schemas/WhatsAppCallbackPayload","kind":"json-schema","title":"WhatsApp Callback Payload","data":{"type":"object","title":"WhatsApp Callback Payload","properties":{"id":{"type":"string","description":"Transaction ID.","example":"aab7faa4-cf35-4931-84d4-2c98cfc935dc"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt and event status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR and event status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#whatsapp-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Delivered"},"timestamp":{"type":"string","description":"Date and time the DLR or event status is received (UTC).","example":"2026-08-13T10:40:21.011Z"},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference ID provided in the original request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"TXN-001"},"transactionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"whatsapp"},"from":{"type":"string","description":"WABA phone number or SMS sender ID.","example":"15554443332"},"to":{"type":"string","description":"Recipient mobile number.","example":"639123456789"},"bsuid":{"type":"string","description":"Recipient BSUID returned by WhatsApp as-is.","example":"PH.1234567891011121"},"parentBsuid":{"type":"string","description":"Recipient parent BSUID returned by WhatsApp as-is.","example":"PH.1234567891011000"},"pricingCategory":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing category returned by WhatsApp as-is."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when transaction is delivered via WhatsApp."},"children":[]}]}]}],"example":"marketing"},"pricingType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing type returned by WhatsApp as-is."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when transaction is delivered via WhatsApp."},"children":[]}]}]}],"example":"regular"},"marketingOptimized":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only if the transaction is delivered via WhatsApp using Marketing Messages API."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes"},"children":[]}]}]}],"example":"yes"},"contacts":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient contact details returned by WhatsApp as-is."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when transaction is delivered via WhatsApp."},"children":[]}]}]}],"additionalProperties":true},"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotexter native error code associated with the transaction-related error occurs during Promotexter's validation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only for error-related callbacks."},"children":[]}]}]}],"example":"200236"},"errorDetails":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp error details returned by WhatsApp as-is."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only for error-related callbacks."},"children":[]}]}]}],"additionalProperties":true}}}},"components/schemas/WhatsAppInboundCallbackPayload":{"id":"components/schemas/WhatsAppInboundCallbackPayload","kind":"json-schema","title":"WhatsApp Inbound Callback Payload","data":{"type":"object","title":"WhatsApp Inbound Callback Payload","properties":{"transaction_id":{"type":"string","description":"Unique transaction ID of the inbound WhatsApp message.","example":"843"},"timestamp":{"type":"string","description":"Date and time the message is received (UTC).","example":"2026-08-13T10:40:21.011Z"},"from":{"type":"string","description":"Sender mobile number of the inbound WhatsApp message.","example":"639123456789"},"to":{"type":"string","description":"Your WhatsApp phone number.","example":"15554443332"},"bsuid":{"type":"string","description":"Sender BSUID of the inbound WhatsApp message.","example":"PH.1234567891011121"},"parentBsuid":{"type":"string","description":"Sender parent BSUID of the inbound WhatsApp message.","example":"PH.1234567891011000"},"contacts":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains recipient contact details returned by WhatsApp callback as-is, such as profile (name, username), user phone number, user BSUID, and parent BSUID."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: The structure of this object may vary depending on WhatsApp's response."},"children":[]}]}]}],"additionalProperties":true},"content":{"$ref":"#/components/schemas/WhatsAppInboundContentObject"},"referral":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains referral details returned by WhatsApp as-is, if the inbound message is sent via a Click to WhatsApp ad."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The structure of this object may vary depending on WhatsApp's response."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Only applicable to the following inbound message types: audio, contacts, documents, image, location, sticker, text, and video."},"children":[]}]}]}],"additionalProperties":true},"context":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains context details returned by WhatsApp as-is, if the inbound message is forwarded to business by WhatsApp end-user."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The structure of this object may vary depending on WhatsApp's response."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Only applicable to the following inbound message types: button, image, text, and video."},"children":[]}]}]}],"additionalProperties":true}},"required":["transaction_id","timestamp","to","content"]}},"components/schemas/WhatsAppInboundContentObject":{"id":"components/schemas/WhatsAppInboundContentObject","kind":"json-schema","title":"WhatsApp Inbound Content Object","data":{"type":"object","title":"WhatsApp Inbound Content Object","properties":{"type":{"type":"string","description":"Contains the type value returned by WhatsApp as-is.","example":"text"},"mediaId":{"type":"string","description":"Internal media ID.","example":"wamid.HBgLNTE1NTQ0NDMzMzIVAgARGBI2ODQ1Q0RERkVGRTY1NkI4NAA="},"mimeType":{"type":"string","description":"Contains the mimeType value returned by WhatsApp as-is.","example":"image/jpeg"},"text":{"type":"string","description":"Text content of the inbound message.","example":"Hello"},"url":{"type":"string","description":"URL of inbound media message. Applicable to image, video, audio, document, and sticker inbound messages.","example":"https://media.example.com/path/file.jpg"},"voice":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable only for voice inbound messages. Indicates if audio is a recording made with the WhatsApp client voice recording feature ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or not ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":true},"filename":{"type":"string","description":"Applicable only for inbound messages with document content. Refers to the filename of the document.","example":"sample.pdf"},"button":{"type":"object","description":"Applicable only for quick reply inbound messages. Contains button details returned by WhatsApp as-is.","additionalProperties":true},"contacts":{"type":"object","description":"Applicable only for inbound messages with contacts content. Contains contacts details returned by WhatsApp as-is.","additionalProperties":true},"interactive":{"type":"object","description":"Applicable only for inbound messages with interactive content. Contains interactive details returned by WhatsApp as-is.","additionalProperties":true},"location":{"type":"object","description":"Applicable only for inbound messages with location content. Contains location details returned by WhatsApp as-is.","additionalProperties":true},"order":{"type":"object","description":"Applicable only for inbound messages with order content. Contains order details returned by WhatsApp as-is.","additionalProperties":true},"reaction":{"type":"object","description":"Applicable only for inbound messages with reaction content. Contains reaction details returned by WhatsApp as-is.","additionalProperties":true}},"required":["type"]}},"components/schemas/SendSmsRequest":{"id":"components/schemas/SendSmsRequest","kind":"json-schema","title":"Single SMS Transaction Request","data":{"type":"object","title":"Single SMS Transaction Request","properties":{"apiKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},"apiSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your SMS sender name. This would appear as the sender of the SMS message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"TestSender"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient of the message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid mobile number."},"children":[]}]}]}],"example":"639123456789"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 10-message parts (1530 standard-GSM or 670 Unicode characters). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the message content must be safelisted. To safelist your URL, you can contact our Support team at support@promotexter.com"},"children":[]}]}]}],"example":"Hello, this is a test message."},"dlrReport":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable DLR notifications for this transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send DLR notifications to the indicated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable DLR notifications. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Overrides account settings."},"children":[]}]}]}],"example":1},"dlrCallback":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Legacy] Your own API endpoint where DLR notifications will be sent via the GET method. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Overrides account settings."},"children":[]}]}]}],"example":"https://example.com/dlr"},"dlrCallbackConfig":{"type":"object","description":"Configuration for receiving DLR notifications via the POST method.","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own API endpoint where DLR notifications will be sent. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com"},"children":[]}]}]}],"example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}]},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR Notification POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/sendSms/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}},"required":["url"]},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference ID to the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 60 characters."},"children":[]}]}]}],"example":"TXN-20260514-0001"}},"required":["from","to","text"]}},"components/schemas/SendEmailRequest":{"id":"components/schemas/SendEmailRequest","kind":"json-schema","title":"Single Email Transaction Request","data":{"type":"object","title":"Single Email Transaction Request","properties":{"apiKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},"apiSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},"fromEmail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your from email address. This would appear as the sender of the email message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"demo@promotexter.com"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient of the message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid email address."},"children":[]}]}]}],"example":"recipient@promotexter.com"},"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subject of the message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 255 characters."},"children":[]}]}]}],"example":"Sample Subject"},"html":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", content is treated as HTML. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", content is treated as plain-text."},"children":[]}]}]}],"example":1},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content of the message in HTML or plain-text format. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 100,000 characters. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the message content must be safelisted. To safelist your URL, you can contact our Support team at support@promotexter.com "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For HTML transactions, include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%Unsubscribe_Link%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder."},"children":[]}]}]}],"example":"<p>Hello from Promotexter</p>"},"fileAttachments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of attachments. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To activate attachment feature, contact support@promotexter.com."},"children":[]}]}]}],"items":{"type":"object","properties":{"attachmentUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the attachment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max size: 1MB."},"children":[]}]}]}],"example":"https://example.com/files/sample.pdf"}},"required":["attachmentUrl"]}},"groupName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference/grouping for the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 255 characters."},"children":[]}]}]}],"example":"Campaign-2026-08"},"dlrReport":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable DLR notifications for this transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send DLR notifications to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Overrides account settings."},"children":[]}]}]}],"example":1},"dlrCallback":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Legacy] Your own API endpoint where DLR notifications will be sent via the GET method. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Overrides account settings."},"children":[]}]}]}],"example":"https://example.com/email-dlr"},"dlrCallbackConfig":{"type":"object","description":"Configuration for receiving DLR notifications via the POST method.","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own API endpoint where DLR notifications will be sent. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com"},"children":[]}]}]}],"example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}]},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR Notification POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/sendEmail/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}},"required":["url"]}},"required":["fromEmail","to","subject","html","body"]}},"components/schemas/EmailResponse":{"id":"components/schemas/EmailResponse","kind":"json-schema","title":"Single Email Transaction Response","data":{"type":"object","title":"Single Email Transaction Response","properties":{"status":{"type":"string","example":"ok"},"message":{"type":"object","properties":{"transactionId":{"type":"string","example":"ab123524523cde134342343211342"},"transactionCost":{"type":"number","example":0.5},"fromEmail":{"type":"string","example":"demo@promotexter.com"},"to":{"type":"string","example":"recipient@promotexter.com"},"subject":{"type":"string","example":"Sample Subject"}},"required":["transactionId","transactionCost","fromEmail","to","subject"]}},"required":["status","message"]}},"components/schemas/SmsResponse":{"id":"components/schemas/SmsResponse","kind":"json-schema","title":"Single SMS Transaction Response","data":{"type":"object","title":"Single SMS Transaction Response","properties":{"status":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"id":{"type":"string","example":"9f6393ce-4eff-41d6-a03b-64d267056d03"},"unitCost":{"type":"number","example":0.5},"transactionCost":{"type":"number","example":0.5},"operatorCode":{"type":"string","example":"PHL_GLOBE"},"messageParts":{"type":"integer","example":1},"from":{"type":"string","example":"Promotexter"},"to":{"type":"string","example":"639170000001"},"source":{"type":"string","example":"112.198.221.111"},"remaining":{"type":"integer","example":100}},"required":["id","unitCost","transactionCost","operatorCode","messageParts","from","to","source","remaining"]}},"required":["status","data"]}},"components/schemas/SendTwoFactorGenerateRequest":{"id":"components/schemas/SendTwoFactorGenerateRequest","kind":"json-schema","title":"Generate Two-Factor Code Request","data":{"type":"object","title":"Generate Two-Factor Code Request","properties":{"apiKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},"apiSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your SMS sender name. This would appear as the sender of the SMS message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be whitelisted to your account."},"children":[]}]}]}],"example":"TestSender"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient of the message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be a valid mobile number."},"children":[]}]}]}],"example":"639123456789"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS message content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%code%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 140 standard-GSM characters."},"children":[]}]}]}],"example":"Your verification code is %code%"},"codelength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of the code to be generated. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Min: 3 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max: 20"},"children":[]}]}]}],"minimum":3,"maximum":20,"default":4,"example":6},"codetype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of code to be generated. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numeric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alphanumeric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alpha"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"numeric","example":"numeric"},"expiration":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration of the transaction in seconds. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Min: 30 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max: 86400"},"children":[]}]}]}],"minimum":30,"maximum":86400,"default":300,"example":300},"attemptLimit":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification attempt limit for incorrect code. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Min: 1 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for no limitation."},"children":[]}]}]}],"minimum":1,"default":null,"example":3},"dlrReport":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable DLR notifications for this transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send DLR notifications to the indicated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dlrCallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable DLR notifications. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Overrides account settings."},"children":[]}]}]}],"example":1},"dlrCallback":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Legacy] Your own API endpoint where DLR notifications will be sent via the GET method. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Overrides account settings."},"children":[]}]}]}],"example":"https://example.com/twofa-dlr"},"dlrCallbackConfig":{"type":"object","description":"Configuration for receiving DLR notifications via the POST method.","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own API endpoint where DLR notifications will be sent. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL must be safelisted. To safelist your URL, contact support@promotexter.com"},"children":[]}]}]}],"example":"https://example.com"},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs of HTTP headers to include in the callback request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers must be safelisted. To safelist your headers, contact support@promotexter.com."},"children":[]}]}]}]},"body":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs to include in the callback request body."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Values may contain dynamic placeholders that will be replaced with actual transaction values. See the supported placeholders in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DLR Notification POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/generateTwoFactorCode/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}},"required":["url"]},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference ID to the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 60 characters."},"children":[]}]}]}],"example":"2FA-20260811-0001"}},"required":["from","to","message"]}},"components/schemas/GenerateTwoFactorCodeResponse":{"id":"components/schemas/GenerateTwoFactorCodeResponse","kind":"json-schema","title":"Generate Two-Factor Code Response","data":{"type":"object","title":"Generate Two-Factor Code Response","properties":{"status":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"id":{"type":"string","example":"ab123524523cde134342343211342"},"unitCost":{"type":"number","example":0.5},"transactionCost":{"type":"number","example":0.5},"operatorCode":{"type":"string","example":"PHL_GLOBE"},"messageParts":{"type":"integer","example":1},"from":{"type":"string","example":"Promotexter"},"to":{"type":"string","example":"639170000001"},"remaining":{"type":"integer","example":100},"expiration":{"type":"integer","example":300}},"required":["id","unitCost","transactionCost","operatorCode","messageParts","from","to","remaining","expiration"]}},"required":["status","data"]}},"components/schemas/VerifyTwoFactorCodeRequest":{"id":"components/schemas/VerifyTwoFactorCodeRequest","kind":"json-schema","title":"Verify Two-Factor Code Request","data":{"type":"object","title":"Verify Two-Factor Code Request","properties":{"apiKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-key"},"apiSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API secret. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required only when not using a Promotexter-generated bearer token."},"children":[]}]}]}],"example":"your-api-secret"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/twofa/generate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"code":{"type":"string","description":"Code to be validated.","example":"123456"}},"required":["id","code"]}},"components/schemas/VerifyTwoFactorCodeResponse":{"id":"components/schemas/VerifyTwoFactorCodeResponse","kind":"json-schema","title":"Verify Two-Factor Code Response","data":{"type":"object","title":"Verify Two-Factor Code Response","properties":{"status":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"message":{"type":"string","example":"Valid"}},"required":["message"]}},"required":["status","data"]}},"components/schemas/RetrieveSmsTransactionsResponse":{"id":"components/schemas/RetrieveSmsTransactionsResponse","kind":"json-schema","title":"Retrieve SMS Transactions Response","data":{"type":"object","title":"Retrieve SMS Transactions Response","properties":{"status":{"type":"string","example":"true"},"totalRows":{"type":"integer","example":62},"totalPages":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"pageNumber":{"type":"integer","example":1},"hasPrevious":{"type":"boolean","example":false},"previousPage":{"type":["integer","null"],"example":null},"hasNext":{"type":"boolean","example":true},"nextPage":{"type":"integer","example":2},"itemsOnPage":{"type":"integer","example":1},"sortColumn":{"type":"string","example":"dateCreated"},"sortDirection":{"type":"string","example":"desc"},"filter":{"type":"object","additionalProperties":{"type":"string"},"example":{"to":"639170000001"}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ab123524523cde134342343211342"},"transactionId":{"type":"string","example":"ab123524523cde134342343211342"},"requestId":{"type":"string","example":"4028fa7c-b2fa-4ed9-ad17-8a971b6dfa96"},"from":{"type":"string","example":"Promotexter"},"to":{"type":"string","example":"639170000001"},"text":{"type":"string","example":"This is a test"},"messageParts":{"type":"integer","example":1},"price":{"type":"number","example":0.5},"dateCreated":{"type":"string","format":"date-time","example":"2023-03-30T03:05:51.054Z"},"dateSent":{"type":"string","format":"date-time","example":"2023-03-30T03:05:51.485Z"},"sendStatus":{"type":"integer","example":1},"dlrStatus":{"type":"integer","example":1},"sourceIp":{"type":"string","example":"112.198.221.111"},"response":{"type":"string","example":"0: Accepted for delivery"},"operator":{"type":"string","example":"PHL_GLOBE"},"country":{"type":"string","example":"PHL"},"description":{"type":"string","example":"sent"}},"required":["id","transactionId","requestId","from","to","text","messageParts","price","dateCreated","dateSent","sendStatus","dlrStatus","sourceIp","response","operator","country","description"]}}},"required":["status","totalRows","totalPages","pageSize","pageNumber","hasPrevious","hasNext","itemsOnPage","sortColumn","sortDirection","data"]}},"components/schemas/ContentParamValidationError":{"id":"components/schemas/ContentParamValidationError","kind":"json-schema","title":"ContentParamValidationError","data":{"type":"object","properties":{"code":{"type":"integer","example":200100},"message":{"type":"string","example":"Parameters validation error."}}}},"components/schemas/UnauthorizedError":{"id":"components/schemas/UnauthorizedError","kind":"json-schema","title":"UnauthorizedError","data":{"type":"object","properties":{"code":{"type":"integer","example":40001},"message":{"type":"string","example":"Unauthorized Access."}}}},"components/schemas/BadRequestError":{"id":"components/schemas/BadRequestError","kind":"json-schema","title":"BadRequestError","data":{"type":"object","properties":{"code":{"type":"integer","example":40004},"message":{"type":"string","example":"Bad Request. Description: [description]"}}}},"components/schemas/HeaderParamValidationError":{"id":"components/schemas/HeaderParamValidationError","kind":"json-schema","title":"HeaderParamValidationError","data":{"type":"object","properties":{"code":{"type":"integer","example":40003},"message":{"type":"string","example":"Parameters validation error."}}}},"schema_13":{"kind":"json-schema","data":{"type":"string"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"anyOf":[{"title":"Text-only","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","text":"This is a sample Viber message.","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}},"eventCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}},"referenceId":"TXN-20260514-0001","sms_from":"Test Sender","sms_text":"This is a sample SMS message."},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"$ref":"#/components/schemas/ViberTextRequest"},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Text + Button","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","text":"This is a sample Viber message.","caption":"Click me","url":"https://examplectaurl.com","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}},"eventCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}},"referenceId":"TXN-20260514-0002","sms_from":"Test Sender","sms_text":"This is a sample SMS message."},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"$ref":"#/components/schemas/ViberTextButtonRequest"},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Image","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","text":"This is a sample Viber message.","image":"https://exampleimageurl.com","caption":"Click me","url":"https://examplectaurl.com","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}},"eventCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}},"referenceId":"TXN-20260514-0002","sms_from":"Test Sender","sms_text":"This is a sample SMS message."},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"$ref":"#/components/schemas/ViberImageRequest"},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Video","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","text":"This is a sample Viber message.","thumbnail":"https://examplethumbnailurl.com","video":"https://examplevideourl.com","caption":"Click me","url":"https://examplectaurl.com","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}},"eventCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}},"referenceId":"TXN-20260514-0003","sms_from":"Test Sender","sms_text":"This is a sample SMS message."},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"$ref":"#/components/schemas/ViberVideoRequest"},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Transactional Templates","oneOf":[{"title":"OTP","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"8b7f2c19-4e35-4d21-b6d8-9f1a7c3e5b62","templateParams":{"pin":"12345"},"templateLang":"en","targetDevice":"all","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}},"eventCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}},"referenceId":"TXN-20260514-0004","sms_from":"Test Sender","sms_text":"Your verification code is %code%"},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"$ref":"#/components/schemas/ViberOtpSimpleRequest"},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]},{"title":"Transactional","example":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"10001","to":"639123456789","templateId":"3be6a2f1-8d9c-4b57-a1e3-7f20c9d64b15","templateParams":{"order_id":"ORD-20260805-1042","delivery_status":"Packed and ready for dispatch"},"templateLang":"en","targetDevice":"all","ttl":86400,"dlrCallback":"https://example.com","eventCallback":"https://example.com","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r","transactionType":"%tr","from":"%f","to":"%t"}},"eventCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","mobileNumber":"%t"}},"referenceId":"TXN-20260514-0005","sms_from":"Test Sender","sms_text":"This is a sample SMS message."},"allOf":[{"$ref":"#/components/schemas/ViberGlobalAuthOptionalBodyCredsParams"},{"$ref":"#/components/schemas/ViberTransactionalRequest"},{"$ref":"#/components/schemas/ViberGlobalOptionalParams"}]}]}]},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"timestamp":{"type":"string","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference ID provided in the original request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"TXN-001"},"transactionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"viber"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber channel ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"2026-05-25T07:41:09.031Z"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"639123456789"},"mobileNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"639123456789"},"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code associated with the transaction-related error. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"200236"}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Event status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8000"},"timestamp":{"type":"string","description":"Date and time the event is received (UTC).","example":"2026-05-25T07:41:09.031Z"},"mobileNumber":{"type":"string","description":"Recipient mobile number.","example":"639123456789"}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WhatsAppCallbackPayload"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/statuscodes#sms-status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"timestamp":{"type":"string","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},"referenceId":{"type":"string","description":"Reference ID provided in the original request.","example":"TXN-001"},"transactionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sms"},"from":{"type":"string","description":"SMS sender ID.","example":"PTXTrial"},"to":{"type":"string","description":"Recipient mobile number.","example":"639123456789"}}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","default":"dateCreated"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","default":"descending","enum":["ascending","descending"]},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/statuscodes#email-status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"delivered"},"timestamp":{"type":"string","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},"transactionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"email"}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://promotexter-api.redocly.app/statuscodes#sms-status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"date":{"type":"string","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},"referenceId":{"type":"string","description":"Reference ID provided in the original request.","example":"TXN-001"},"from":{"type":"string","description":"SMS sender ID.","example":"PTXTrial"},"to":{"type":"string","description":"Recipient mobile number.","example":"639123456789"}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Transaction ID.","example":"7bf6858c-fo97-4a27-b866-1c62b7617869"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery receipt status of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DLR status codes can be viewed "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://promotexter-api.redocly.app/statuscodes#viber-status-codes","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"timestamp":{"type":"string","description":"Date and time the DLR is received (UTC).","example":"2026-05-25T07:41:09.031Z"},"referenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference ID provided in the original request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"TXN-001"},"transactionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of channel to which the transaction is delivered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Possible value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"viber"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viber channel ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"10001"},"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for DLR-related callbacks."},"children":[]}]}]}],"example":"639123456789"},"mobileNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient mobile numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"639123456789"},"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code associated with the transaction-related error. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned only for error-related callbacks."},"children":[]}]}]}],"example":"200236"}}},"id":"schema_25"}},"exampleStore":{"components/examples/GeneratePromotexterTokenResponseExample":{"id":"components/examples/GeneratePromotexterTokenResponseExample","value":{"status":"ok","data":"eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJwcm9tb3RleHRlci1hcGkiLCJzdWIiOiJ1c2VyLTEyMzQ1IiwiaWF0IjoxNzI0Njk5MDAwLCJleHAiOjE3MjQ3MDI2MDB9.Nk9vZ0RrQ2lMZ3J4V2hXQ1VnU1lRZ2tVQ2p2R0xZbFJfN3hWQ1M5M1F4Q2lCd2hSQ3dZVnVqS0h2Y1J0T1lFQmVxS2VxR0ZkWnV5R2w"},"summary":"Generate Promotexter token response"},"components/examples/getAccountBalanceResponseExample":{"id":"components/examples/getAccountBalanceResponseExample","value":{"availableBalance":905.57,"accountBalance":-9096.95,"creditLimit":10000,"withheld":-2.52},"summary":"Account balance response"},"components/examples/ViberResponseExample":{"id":"components/examples/ViberResponseExample","value":{"transactionId":"aab7faa4-cf35-4931-84d4-2c98cfc935dc","requestId":"4c300362-d3f9-402d-8c80-af0bd10daacb"},"summary":"Promotional text-only response"},"components/examples/SendWhatsAppRequestExample":{"id":"components/examples/SendWhatsAppRequestExample","value":{"to":"639123456789","recipient":"PH.1234567891011121","from":"15554443332","type":"template","template":{"name":"test_marketing_template","language":{"code":"en"},"components":[{"type":"header","parameters":[{"type":"text","parameter_name":"first_name","text":"John"}]},{"type":"body","parameters":[{"type":"text","parameter_name":"first_name","text":"John"},{"type":"text","parameter_name":"last_name","text":"Doe"},{"type":"text","parameter_name":"promo_code","text":"123ABC"}]}]},"callbackConfig":{"url":"https://example.com"},"referenceId":"referenceId_123","sms_from":"TESTSMS","sms_text":"This is a whatsapp fallback message"},"summary":"WhatsApp marketing template request"},"components/examples/WhatsAppResponseExample":{"id":"components/examples/WhatsAppResponseExample","value":{"transactionId":"aab7faa4-cf35-4931-84d4-2c98cfc935dc","requestId":"4c300362-d3f9-402d-8c80-af0bd10daacb"},"summary":"WhatsApp send response"},"components/examples/SmsResponseExample":{"id":"components/examples/SmsResponseExample","value":{"status":"ok","data":{"id":"9f6393ce-4eff-41d6-a03b-64d267056d03","unitCost":0.5,"transactionCost":0.5,"operatorCode":"PHL_GLOBE","messageParts":1,"from":"TestSender","to":"639123456789","source":"112.198.221.111","remaining":100}},"summary":"Single SMS transaction response"},"components/examples/EmailResponseExample":{"id":"components/examples/EmailResponseExample","value":{"status":"ok","message":{"transactionId":"ab123524523cde134342343211342","transactionCost":0.5,"fromEmail":"demo@promotexter.com","to":"recipient@promotexter.com","subject":"Sample Subject"}},"summary":"Single Email transaction response"},"components/examples/GenerateTwoFactorCodeResponseExample":{"id":"components/examples/GenerateTwoFactorCodeResponseExample","value":{"status":"ok","data":{"id":"ab123524523cde134342343211342","unitCost":0.5,"transactionCost":0.5,"operatorCode":"PHL_GLOBE","messageParts":1,"from":"Promotexter","to":"639170000001","remaining":100,"expiration":300}},"summary":"Generate two-factor code response"},"components/examples/VerifyTwoFactorCodeResponseExample":{"id":"components/examples/VerifyTwoFactorCodeResponseExample","value":{"status":"ok","data":{"message":"Valid"}},"summary":"Verify two-factor code response"},"components/examples/RetrieveSmsTransactionsResponseExample":{"id":"components/examples/RetrieveSmsTransactionsResponseExample","value":{"status":"true","totalRows":62,"totalPages":1,"pageSize":1,"pageNumber":1,"hasPrevious":false,"previousPage":null,"hasNext":true,"nextPage":2,"itemsOnPage":1,"sortColumn":"dateCreated","sortDirection":"desc","filter":{"to":"639170000001"},"data":[{"id":"ab123524523cde134342343211342","transactionId":"ab123524523cde134342343211342","requestId":"4028fa7c-b2fa-4ed9-ad17-8a971b6dfa96","from":"Promotexter","to":"639170000001","text":"This is a test","messageParts":1,"price":0.5,"dateCreated":"2023-03-30T03:05:51.054Z","dateSent":"2023-03-30T03:05:51.485Z","sendStatus":1,"dlrStatus":1,"sourceIp":"112.198.221.111","response":"0: Accepted for delivery","operator":"PHL_GLOBE","country":"PHL","description":"sent"}]},"summary":"Retrieve SMS transactions response"},"paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example":{"value":{"expiresInSeconds":3600},"key":"default_example","summary":"default_example","id":"paths/~1generate-token/post/requestBody/content/application~1json/examples/default_example"},"paths/~1generate-token/post/responses/200/content/application~1json/examples/default_example":{"value":{"status":"ok","data":"eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJwcm9tb3RleHRlci1hcGkiLCJzdWIiOiJ1c2VyLTEyMzQ1IiwiaWF0IjoxNzI0Njk5MDAwLCJleHAiOjE3MjQ3MDI2MDB9.Nk9vZ0RrQ2lMZ3J4V2hXQ1VnU1lRZ2tVQ2p2R0xZbFJfN3hWQ1M5M1F4Q2lCd2hSQ3dZVnVqS0h2Y1J0T1lFQmVxS2VxR0ZkWnV5R2w"},"key":"default_example","summary":"Generate Promotexter token response","id":"paths/~1generate-token/post/responses/200/content/application~1json/examples/default_example"},"paths/~1api~1account~1balance/get/responses/200/content/application~1json/examples/default_example":{"value":{"availableBalance":905.57,"accountBalance":-9096.95,"creditLimit":10000,"withheld":-2.52},"key":"default_example","summary":"Account balance response","id":"paths/~1api~1account~1balance/get/responses/200/content/application~1json/examples/default_example"},"paths/~1viber~1send/post/responses/200/content/application~1json/examples/default_example":{"value":{"transactionId":"aab7faa4-cf35-4931-84d4-2c98cfc935dc","requestId":"4c300362-d3f9-402d-8c80-af0bd10daacb"},"key":"default_example","summary":"Promotional text-only response","id":"paths/~1viber~1send/post/responses/200/content/application~1json/examples/default_example"},"paths/~1whatsapp~1send/post/responses/200/content/application~1json/examples/default_example":{"value":{"transactionId":"aab7faa4-cf35-4931-84d4-2c98cfc935dc","requestId":"4c300362-d3f9-402d-8c80-af0bd10daacb"},"key":"default_example","summary":"WhatsApp send response","id":"paths/~1whatsapp~1send/post/responses/200/content/application~1json/examples/default_example"},"paths/~1sms~1send/post/requestBody/content/application~1json/example":{"value":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"TestSender","to":"639123456789","text":"Hello, this is a test message.","dlrReport":1,"dlrCallback":"https://example.com/dlr","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r"}},"referenceId":"TXN-20260514-0001"},"id":"paths/~1sms~1send/post/requestBody/content/application~1json/example"},"paths/~1sms~1send/post/responses/200/content/application~1json/examples/default_example":{"value":{"status":"ok","data":{"id":"9f6393ce-4eff-41d6-a03b-64d267056d03","unitCost":0.5,"transactionCost":0.5,"operatorCode":"PHL_GLOBE","messageParts":1,"from":"TestSender","to":"639123456789","source":"112.198.221.111","remaining":100}},"key":"default_example","summary":"Single SMS transaction response","id":"paths/~1sms~1send/post/responses/200/content/application~1json/examples/default_example"},"paths/~1api~1sms/get/responses/200/content/application~1json/examples/default_example":{"value":{"status":"true","totalRows":62,"totalPages":1,"pageSize":1,"pageNumber":1,"hasPrevious":false,"previousPage":null,"hasNext":true,"nextPage":2,"itemsOnPage":1,"sortColumn":"dateCreated","sortDirection":"desc","filter":{"to":"639170000001"},"data":[{"id":"ab123524523cde134342343211342","transactionId":"ab123524523cde134342343211342","requestId":"4028fa7c-b2fa-4ed9-ad17-8a971b6dfa96","from":"Promotexter","to":"639170000001","text":"This is a test","messageParts":1,"price":0.5,"dateCreated":"2023-03-30T03:05:51.054Z","dateSent":"2023-03-30T03:05:51.485Z","sendStatus":1,"dlrStatus":1,"sourceIp":"112.198.221.111","response":"0: Accepted for delivery","operator":"PHL_GLOBE","country":"PHL","description":"sent"}]},"key":"default_example","summary":"Retrieve SMS transactions response","id":"paths/~1api~1sms/get/responses/200/content/application~1json/examples/default_example"},"paths/~1email/post/requestBody/content/application~1json/example":{"value":{"apiKey":"your-api-key","apiSecret":"your-api-secret","fromEmail":"demo@promotexter.com","to":"recipient@promotexter.com","subject":"Sample Subject","html":1,"body":"<p>Hello from Promotexter</p>","fileAttachments":[{"attachmentUrl":"https://example.com/files/sample.pdf"}],"groupName":"Campaign-2026-08","dlrReport":1,"dlrCallback":"https://example.com/email-dlr","dlrCallbackConfig":{"url":"https://example.com","headers":{"X-Custom-Header":"test-value"},"body":{"id":"%i","status":"%s","timestamp":"%d","referenceId":"%r"}}},"id":"paths/~1email/post/requestBody/content/application~1json/example"},"paths/~1email/post/responses/200/content/application~1json/examples/default_example":{"value":{"status":"ok","message":{"transactionId":"ab123524523cde134342343211342","transactionCost":0.5,"fromEmail":"demo@promotexter.com","to":"recipient@promotexter.com","subject":"Sample Subject"}},"key":"default_example","summary":"Single Email transaction response","id":"paths/~1email/post/responses/200/content/application~1json/examples/default_example"},"paths/~1twofa~1generate/post/requestBody/content/application~1json/example":{"value":{"apiKey":"your-api-key","apiSecret":"your-api-secret","from":"TestSender","to":"639123456789","message":"Your verification code is %code%","codelength":6,"codetype":"numeric","expiration":300,"attemptLimit":3,"dlrReport":1,"dlrCallback":"https://example.com/twofa-dlr","dlrCallbackConfig":{"url":"https://example.com/twofa-dlr-post"},"referenceId":"2FA-20260811-0001"},"id":"paths/~1twofa~1generate/post/requestBody/content/application~1json/example"},"paths/~1twofa~1generate/post/responses/200/content/application~1json/examples/default_example":{"value":{"status":"ok","data":{"id":"ab123524523cde134342343211342","unitCost":0.5,"transactionCost":0.5,"operatorCode":"PHL_GLOBE","messageParts":1,"from":"Promotexter","to":"639170000001","remaining":100,"expiration":300}},"key":"default_example","summary":"Generate two-factor code response","id":"paths/~1twofa~1generate/post/responses/200/content/application~1json/examples/default_example"},"paths/~1twofa~1verify/post/requestBody/content/application~1json/example":{"value":{"apiKey":"your-api-key","apiSecret":"your-api-secret","id":"7bf6858c-fo97-4a27-b866-1c62b7617869","code":"123456"},"id":"paths/~1twofa~1verify/post/requestBody/content/application~1json/example"},"paths/~1twofa~1verify/post/responses/200/content/application~1json/examples/default_example":{"value":{"status":"ok","data":{"message":"Valid"}},"key":"default_example","summary":"Verify two-factor code response","id":"paths/~1twofa~1verify/post/responses/200/content/application~1json/examples/default_example"},"paths/~1viber~1send‌/post/responses/200/content/application~1json/examples/default_example":{"value":{"transactionId":"aab7faa4-cf35-4931-84d4-2c98cfc935dc","requestId":"4c300362-d3f9-402d-8c80-af0bd10daacb"},"key":"default_example","summary":"Promotional text-only response","id":"paths/~1viber~1send‌/post/responses/200/content/application~1json/examples/default_example"},"paths/~1whatsapp~1send‌/post/responses/200/content/application~1json/examples/default_example":{"value":{"transactionId":"aab7faa4-cf35-4931-84d4-2c98cfc935dc","requestId":"4c300362-d3f9-402d-8c80-af0bd10daacb"},"key":"default_example","summary":"WhatsApp send response","id":"paths/~1whatsapp~1send‌/post/responses/200/content/application~1json/examples/default_example"}},"securitySchemeStore":{"Promotexter token":{"id":"Promotexter token","type":"http","scheme":"bearer","bearerFormat":"JWT"},"Client token":{"id":"Client token","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client token used to request a Promotexter token from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/generate-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/api","isMockServer":true,"description":"Mock server"},{"url":"https://api.promotexter.com"}]},"options":{"hideDownloadButtons":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api.json?download"},{"url":"/_bundle/api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Promotexter API","description":"Welcome to the **Promotexter API Reference**. <br><br>The Promotexter API provides REST-based services for multi-channel communication, supporting SMS, Email, Viber, WhatsApp, verification, and voice calls that allows you to integrate multi-channel communication directly into your web applications, platforms, and CRM software.\n<br><br>\n<span style=\"font-size: 1.35em;\"><b>Quick Start Guide</b></span>\n\nGetting started with Promotexter takes just three steps:\n\n1. Create an account by contacting your Account Manager at sales@promotexter.com or our Support team at support@promotexter.com\n2. Whitelist your IP address to access the Promotexter API services by contacting the Support team.\n3. Generate your Promotexter token or API key and secret. Obtain your secure API key and secret from the portal, or follow the instructions [here](https://promotexter-api.redocly.app/api/api-authentication) to obtain your token.\n\nOnce everything is set up, you are now ready to send your first request by using your Promotexter token or API key and secret for authentication.\n"}},"baseSlug":"/api","routesMapping":{}}