{"items":[{"type":"link","label":"Namirial WhatsApp Gateway API","link":"/products/whatsapp/openapi","routeSlug":"/products/whatsapp/openapi","content":{"contentType":"overview","meta":{"name":"Namirial WhatsApp Gateway API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/whatsapp/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/whatsapp/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"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"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Namirial WhatsApp Gateway API (2.1.0.0)","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":"API for sending WhatsApp messages via the Namirial WhatsApp Gateway. Supports template-based messaging, OTP delivery, and template management."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication requires both Basic Auth credentials and an API key header ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}]}],"sectionId":"/"},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/whatsapp/","description":"Namirial WhatsApp Gateway documentation"}],"sectionId":"/"}]}]}},{"type":"group","label":"Services","link":"/products/whatsapp/openapi/services","routeSlug":"/products/whatsapp/openapi/services","items":[{"label":"Send a WhatsApp message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/services/sendwhatsappmessage","routeSlug":"/products/whatsapp/openapi/services/sendwhatsappmessage","metadata":{"seo":{"title":"Send a WhatsApp message","description":"Sends a WhatsApp message to the specified recipient using a pre-approved utility template. Supports body parameters, URL buttons, and an optional reference for tracking. See Send a message for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendWhatsAppMessage","name":"Send a WhatsApp message","isWebhook":false,"pointer":"/paths/~1api~1services~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a WhatsApp message","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 to the specified recipient using a pre-approved utility template. Supports body parameters, URL buttons, and an optional reference for tracking. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/api-references/send-message-apis/send"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendRequest","exampleIds":["paths/~1api~1services~1send/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SendRequest","exampleIds":["paths/~1api~1services~1send/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1services~1send/post/requestBody","description":"WhatsApp message request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/services/send","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"},{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SendRequest","exampleIds":["paths/~1api~1services~1send/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/api/services/send","href":"services/sendwhatsappmessage","openApiOperationId":"sendWhatsAppMessage","summary":"Send a WhatsApp message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"schemaId":"components/schemas/SendRequest","exampleIds":["paths/~1api~1services~1send/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendRequest","exampleIds":["paths/~1api~1services~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":"Message sent successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request — missing or malformed parameters."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidInput","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidTemplate","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/wrongNumber"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidInput","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidTemplate","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/wrongNumber"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidApiKey"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidApiKey"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the account does not have the required role."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/403/content/application~1json/examples/forbidden"]}],"pointer":"/paths/~1api~1services~1send/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidInput","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidTemplate","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/wrongNumber"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidInput","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidTemplate","paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/wrongNumber"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidApiKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidApiKey"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send/post/responses/403/content/application~1json/examples/forbidden"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/sendwhatsappmessage"}],"panels":[]}]},"httpPath":"/api/services/send"},{"label":"Send a WhatsApp OTP message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/services/sendwhatsappotp","routeSlug":"/products/whatsapp/openapi/services/sendwhatsappotp","metadata":{"seo":{"title":"Send a WhatsApp OTP message","description":"Sends a one-time password (OTP) via WhatsApp using a pre-approved authentication template. See Send an OTP message for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendWhatsAppOtp","name":"Send a WhatsApp OTP message","isWebhook":false,"pointer":"/paths/~1api~1services~1send-otp/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a WhatsApp OTP message","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 one-time password (OTP) via WhatsApp using a pre-approved authentication template. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/api-references/send-message-apis/send-otp"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send an OTP message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendOtpRequest","exampleIds":["paths/~1api~1services~1send-otp/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SendOtpRequest","exampleIds":["paths/~1api~1services~1send-otp/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1services~1send-otp/post/requestBody","description":"WhatsApp OTP request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/services/send-otp","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"},{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SendOtpRequest","exampleIds":["paths/~1api~1services~1send-otp/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401"],"pointer":"/api/services/send-otp","href":"services/sendwhatsappotp","openApiOperationId":"sendWhatsAppOtp","summary":"Send a WhatsApp OTP message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"schemaId":"components/schemas/SendOtpRequest","exampleIds":["paths/~1api~1services~1send-otp/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendOtpRequest","exampleIds":["paths/~1api~1services~1send-otp/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":"OTP message sent successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request — missing or malformed parameters."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/missingOtp","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/invalidTemplateId","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/wrongNumber","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/templateNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/missingOtp","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/invalidTemplateId","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/wrongNumber","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/templateNotFound"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidApiKey"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidApiKey"]}],"pointer":"/paths/~1api~1services~1send-otp/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/missingOtp","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/invalidTemplateId","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/wrongNumber","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/templateNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/missingOtp","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/invalidTemplateId","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/wrongNumber","paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/templateNotFound"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidApiKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidApiKey"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/sendwhatsappotp"}],"panels":[]}]},"httpPath":"/api/services/send-otp"}],"content":{"contentType":"group","meta":{"name":"Services"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Services","showPageActions":true},{"nodeType":"markdoc","content":"Send WhatsApp messages to end users."},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/whatsapp/","description":"WhatsApp Gateway documentation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/services/send","summary":"Send a WhatsApp message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/sendwhatsappmessage","deprecated":false},{"title":"/api/services/send-otp","summary":"Send a WhatsApp OTP message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/sendwhatsappotp","deprecated":false}]}]}]}]}},{"type":"group","label":"Template","link":"/products/whatsapp/openapi/template","routeSlug":"/products/whatsapp/openapi/template","items":[{"label":"Create a template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/template/createtemplate","routeSlug":"/products/whatsapp/openapi/template/createtemplate","metadata":{"seo":{"title":"Create a template","description":"Creates a new WhatsApp message template. Templates must be approved by WhatsApp before they can be used for sending messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTemplate","name":"Create a template","isWebhook":false,"pointer":"/paths/~1api~1template~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new WhatsApp message template. Templates must be approved by WhatsApp before they can be used for sending messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequest"}},"schemaId":"components/schemas/CreateTemplateRequest","pointer":"/paths/~1api~1template~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/template/create","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"},{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/api/template/create","href":"template/createtemplate","openApiOperationId":"createTemplate","summary":"Create a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"schemaId":"components/schemas/CreateTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template created successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1create/post/responses/400/content/application~1json/examples/invalidCategory"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1create/post/responses/400/content/application~1json/examples/invalidCategory"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the account is not authorized to perform this operation."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1template~1create/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1create/post/responses/400/content/application~1json/examples/invalidCategory"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1create/post/responses/400/content/application~1json/examples/invalidCategory"]}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/createtemplate"}],"panels":[]}]},"httpPath":"/api/template/create"},{"label":"Get a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/template/gettemplate","routeSlug":"/products/whatsapp/openapi/template/gettemplate","metadata":{"seo":{"title":"Get a template","description":"Retrieves a specific template by its ID and language."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplate","name":"Get a template","isWebhook":false,"pointer":"/paths/~1api~1template~1{templateId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific template by its ID and language."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template.","required":true}],"pointer":"/paths/~1api~1template~1{templateId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code of the template (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1template~1{templateId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/template/{templateId}","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[{"name":"templateId","in":"path","required":true,"example":1,"schemaId":"schema_0"}],"query":[{"name":"language","in":"query","required":true,"example":"it","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"},{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/api/template/{templateId}","href":"template/gettemplate","openApiOperationId":"getTemplate","summary":"Get a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Template","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/utilityTemplate","paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/authenticationTemplate"]}},"schemaId":"components/schemas/Template","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/utilityTemplate","paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/authenticationTemplate"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidApiKey"]}},"exampleIds":["paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidApiKey"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the account does not have the required role."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Template not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1template~1{templateId}/get/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1template~1{templateId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1template~1{templateId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Template","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/utilityTemplate","paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/authenticationTemplate"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Template","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/utilityTemplate","paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/authenticationTemplate"]}}},{"code":"401","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidApiKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidCredentials","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/missingApiKey","paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidApiKey"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","exampleIds":["paths/~1api~1template~1{templateId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1template~1{templateId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/gettemplate"}],"panels":[]}]},"httpPath":"/api/template/{templateId}"},{"label":"Add a language to a template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/template/addtemplatelanguage","routeSlug":"/products/whatsapp/openapi/template/addtemplatelanguage","metadata":{"seo":{"title":"Add a language to a template","description":"Adds a new language variant to an existing template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTemplateLanguage","name":"Add a language to a template","isWebhook":false,"pointer":"/paths/~1api~1template~1{templateId}~1language/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a language to a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new language variant to an existing template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template.","required":true}],"pointer":"/paths/~1api~1template~1{templateId}~1language/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddLanguageRequest"}},"schemaId":"components/schemas/AddLanguageRequest","pointer":"/paths/~1api~1template~1{templateId}~1language/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/template/{templateId}/language","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[{"name":"templateId","in":"path","required":true,"example":1,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"},{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddLanguageRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/template/{templateId}/language","href":"template/addtemplatelanguage","openApiOperationId":"addTemplateLanguage","summary":"Add a language to a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"schemaId":"components/schemas/AddLanguageRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddLanguageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Language added successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/languageExists","paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/invalidLanguage"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/languageExists","paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/invalidLanguage"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the account is not authorized to perform this operation."},"children":[]}]}]}]},{"code":"404","description":"Template not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1template~1{templateId}~1language/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/languageExists","paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/invalidLanguage"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/languageExists","paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/invalidLanguage"]}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1language/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/addtemplatelanguage"}],"panels":[]}]},"httpPath":"/api/template/{templateId}/language"},{"label":"Get all template languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/template/gettemplatelanguages","routeSlug":"/products/whatsapp/openapi/template/gettemplatelanguages","metadata":{"seo":{"title":"Get all template languages","description":"Returns all available language variants for a specific template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplateLanguages","name":"Get all template languages","isWebhook":false,"pointer":"/paths/~1api~1template~1{templateId}~1languages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all template languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all available language variants for a specific template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template.","required":true}],"pointer":"/paths/~1api~1template~1{templateId}~1languages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/template/{templateId}/languages","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[{"name":"templateId","in":"path","required":true,"example":1,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"},{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/api/template/{templateId}/languages","href":"template/gettemplatelanguages","openApiOperationId":"getTemplateLanguages","summary":"Get all template languages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of template languages retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the account does not have the required role."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Template not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1template~1{templateId}~1languages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1template~1{templateId}~1languages/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/gettemplatelanguages"}],"panels":[]}]},"httpPath":"/api/template/{templateId}/languages"}],"content":{"contentType":"group","meta":{"name":"Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template","showPageActions":true},{"nodeType":"markdoc","content":"Manage WhatsApp message templates."},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/whatsapp/","description":"WhatsApp Gateway documentation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/template/create","summary":"Create a template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template/createtemplate","deprecated":false},{"title":"/api/template/{templateId}","summary":"Get a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template/gettemplate","deprecated":false},{"title":"/api/template/{templateId}/language","summary":"Add a language to a template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template/addtemplatelanguage","deprecated":false},{"title":"/api/template/{templateId}/languages","summary":"Get all template languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template/gettemplatelanguages","deprecated":false}]}]}]}]}},{"type":"group","label":"Public","link":"/products/whatsapp/openapi/public","routeSlug":"/products/whatsapp/openapi/public","items":[{"label":"Check service status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/whatsapp/openapi/public/getservicestatus","routeSlug":"/products/whatsapp/openapi/public/getservicestatus","metadata":{"seo":{"title":"Check service status","description":"Returns the current operational status of the WhatsApp Gateway service. No authentication required. The response body is empty — an HTTP 200 indicates the service is up."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServiceStatus","name":"Check service status","isWebhook":false,"pointer":"/paths/~1api~1public~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check service status","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":"Returns the current operational status of the WhatsApp Gateway service. No authentication required. The response body is empty — an HTTP 200 indicates the service is up."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/public/status","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/public/status","href":"public/getservicestatus","openApiOperationId":"getServiceStatus","summary":"Check service status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Service is operational.","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_3"}},"schemaId":"schema_3"}],"pointer":"/paths/~1api~1public~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_3"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public/getservicestatus"}],"panels":[]}]},"httpPath":"/api/public/status"}],"content":{"contentType":"group","meta":{"name":"Public"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Public","showPageActions":true},{"nodeType":"markdoc","content":"Public endpoints. No authentication required."},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/whatsapp/","description":"WhatsApp Gateway documentation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/public/status","summary":"Check service status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/public/getservicestatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SendResponse":{"id":"components/schemas/SendResponse","kind":"json-schema","title":"SendResponse","data":{"type":"object","description":"Response returned when a message is sent successfully.","properties":{"messageId":{"type":"string","description":"Unique identifier of the sent message.","example":"3425151601"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","description":"Error response returned when a request fails.","properties":{"type":{"type":"string","description":"Exception type identifier."},"code":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric error code. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}]},"message":{"type":"string","description":"Human-readable error description."},"errorDetails":{"type":["array","null"],"description":"Additional validation error details, present on constraint violations.","items":{"type":"object","properties":{"field":{"type":"string","description":"The field that failed validation."},"message":{"type":"string","description":"Validation error message."}}}}}}},"components/schemas/SendRequest":{"id":"components/schemas/SendRequest","kind":"json-schema","title":"SendRequest","data":{"type":"object","required":["to","language","templateId"],"properties":{"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 phone number in E.164 format (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+390000000000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"+390000000000"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code of the template to use (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Falls back to the template's default language if not found."},"children":[]}]}]}],"example":"it"},"templateId":{"type":"integer","format":"int64","minimum":0,"description":"Identifier of the WhatsApp template to use.","example":3},"businessRelationId":{"type":["string","null"],"description":"Optional business relation identifier for internal tracking."},"lra":{"type":["string","null"],"description":"Local Registration Authority (LRA) identifier."},"reference":{"allOf":[{"$ref":"#/components/schemas/ReferenceService"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional reference object for tracking. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/sms/enterprise-documentation/developer-documentation/integration-guide/attribute-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Attribute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},"body":{"allOf":[{"$ref":"#/components/schemas/BodyComponent"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template body component with dynamic parameters. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/api-references/send-message-apis#body-component"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body component"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on how to use placeholders."},"children":[]}]}]}]},"urlButtons":{"type":["array","null"],"description":"List of URL button components with dynamic URL paths.","items":{"$ref":"#/components/schemas/UrlButtonTypeComponent"}}}}},"components/schemas/SendOtpRequest":{"id":"components/schemas/SendOtpRequest","kind":"json-schema","title":"SendOtpRequest","data":{"type":"object","required":["to","language","otp","templateId"],"properties":{"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 phone number in E.164 format (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+390000000000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"+390000000000"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code of the authentication template to use (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Falls back to the template's default language if not found."},"children":[]}]}]}],"example":"it"},"templateId":{"type":"integer","format":"int64","minimum":0,"description":"Identifier of the authentication template to use.","example":1},"otp":{"type":"string","minLength":1,"description":"The one-time password to include in the message (max 15 characters, as per Meta authentication template restrictions).","example":"123456"},"businessRelationId":{"type":["string","null"],"description":"Optional One Platform Business Relation ID. If specified, consumption is attributed to this BRI."},"lra":{"type":["string","null"],"description":"Local Registration Authority (LRA) identifier."},"reference":{"allOf":[{"$ref":"#/components/schemas/ReferenceService"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional reference object for tracking. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/sms/enterprise-documentation/developer-documentation/integration-guide/attribute-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Attribute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}}}},"components/schemas/Template":{"id":"components/schemas/Template","kind":"json-schema","title":"Template","data":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Template name."},"description":{"type":["string","null"],"description":"Template description."},"language":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code of the template (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list of valid values."},"children":[]}]}]}],"example":"it"},"category":{"type":["string","null"],"description":"WhatsApp template category.","enum":["UTILITY","MARKETING","AUTHENTICATION"]},"status":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template approval status (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"templateId":{"type":["string","null"],"description":"Unique identifier of the template."},"default":{"type":["boolean","null"],"description":"Whether this is the default language variant for the template."},"body":{"allOf":[{"$ref":"#/components/schemas/BodyComponent"}],"description":"Template body component."},"textHeader":{"allOf":[{"$ref":"#/components/schemas/TextHeaderComponent"}],"description":"Template text header component."},"footer":{"allOf":[{"$ref":"#/components/schemas/FooterComponent"}],"description":"Template footer component."},"urlButtons":{"type":["array","null"],"description":"List of URL button components.","items":{"$ref":"#/components/schemas/UrlButtonTypeComponent"}}}}},"components/schemas/ReferenceService":{"id":"components/schemas/ReferenceService","kind":"json-schema","title":"ReferenceService","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional reference object to track messages and associate them with specific services or actions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are specified."},"children":[]}]}]}],"properties":{"service":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the product or service sending the message. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are specified."},"children":[]}]}]}],"maxLength":50},"action":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the specific action for the selected service (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2FA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"maxLength":50},"key":{"type":["string","null"],"description":"Custom tracking key for internal processes.","maxLength":255}}}},"components/schemas/BodyComponent":{"id":"components/schemas/BodyComponent","kind":"json-schema","title":"BodyComponent","data":{"type":"object","description":"Template body component containing dynamic text parameters.","properties":{"text":{"type":["string","null"],"description":"Static body text."},"parameters":{"type":["array","null"],"description":"List of dynamic text parameters to substitute in the template body.","items":{"$ref":"#/components/schemas/TextTypeParameter"}}}}},"components/schemas/TextHeaderComponent":{"id":"components/schemas/TextHeaderComponent","kind":"json-schema","title":"TextHeaderComponent","data":{"type":"object","description":"Template text header component.","properties":{"text":{"type":["string","null"],"description":"Header text."}}}},"components/schemas/FooterComponent":{"id":"components/schemas/FooterComponent","kind":"json-schema","title":"FooterComponent","data":{"type":"object","description":"Template footer component.","properties":{"text":{"type":["string","null"],"description":"Footer text."},"codeExpirationMinutes":{"type":["integer","null"],"format":"int32","description":"OTP code expiration time in minutes."}}}},"components/schemas/UrlButtonTypeComponent":{"id":"components/schemas/UrlButtonTypeComponent","kind":"json-schema","title":"UrlButtonTypeComponent","data":{"type":"object","description":"URL button component with a dynamic URL path suffix.","properties":{"index":{"type":["integer","null"],"format":"int32","description":"Zero-based index of the URL button in the template."},"urlPath":{"type":["string","null"],"description":"Dynamic path suffix appended to the button's base URL."},"url":{"type":["string","null"],"description":"Full URL override for the button."},"text":{"type":["string","null"],"description":"Button label text."}}}},"components/schemas/TextTypeParameter":{"id":"components/schemas/TextTypeParameter","kind":"json-schema","title":"TextTypeParameter","data":{"type":"object","description":"A single dynamic text parameter for template substitution.","properties":{"text":{"type":["string","null"],"description":"Parameter value to substitute in the template."}}}},"components/schemas/CreateTemplateRequest":{"id":"components/schemas/CreateTemplateRequest","kind":"json-schema","title":"CreateTemplateRequest","data":{"type":"object","required":["language","category","name","description","body"],"properties":{"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default template language. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"en"},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template category. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" templates, contact Namirial support for the accepted parameters."},"children":[]}]}]}],"enum":["UTILITY","MARKETING","AUTHENTICATION"]},"name":{"type":"string","description":"Template name. Only alphabetic characters and underscores (max 100 characters).","example":"signature_template"},"description":{"type":"string","description":"Template description.","example":"sign a doc using a link"},"body":{"allOf":[{"$ref":"#/components/schemas/BodyComponent"}],"description":"Template body component."},"urlButtons":{"type":["array","null"],"description":"URL button components. Max 2 buttons.","items":{"$ref":"#/components/schemas/UrlButtonTypeComponent"}},"textHeader":{"allOf":[{"$ref":"#/components/schemas/TextHeaderComponent"}],"description":"Template text header component."},"footer":{"allOf":[{"$ref":"#/components/schemas/FooterComponent"}],"description":"Template footer component."}}}},"components/schemas/AddLanguageRequest":{"id":"components/schemas/AddLanguageRequest","kind":"json-schema","title":"AddLanguageRequest","data":{"type":"object","required":["language","body"],"properties":{"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new language to add. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"it"},"body":{"allOf":[{"$ref":"#/components/schemas/BodyComponent"}],"description":"Template body component in the new language."},"urlButtons":{"type":["array","null"],"description":"URL button components for the new language version. Max 2 buttons.","items":{"$ref":"#/components/schemas/UrlButtonTypeComponent"}},"textHeader":{"allOf":[{"$ref":"#/components/schemas/TextHeaderComponent"}],"description":"Template text header component in the new language."},"footer":{"allOf":[{"$ref":"#/components/schemas/FooterComponent"}],"description":"Template footer component in the new language."}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":1},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","example":"it"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["de","en","fr","it"]},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","example":""},"id":"schema_3"}},"exampleStore":{"paths/~1api~1services~1send/post/requestBody/content/application~1json/example":{"value":{"to":"+390000000000","language":"it","templateId":3,"body":{"parameters":[{"text":"Rome"},{"text":"m.rossi"}]},"urlButtons":[{"index":0,"urlPath":"/my/url/path"}],"reference":{"service":"DIGITALSIGN","action":"AUTH","key":"ext-key-001"}},"id":"paths/~1api~1services~1send/post/requestBody/content/application~1json/example"},"paths/~1api~1services~1send/post/responses/200/content/application~1json/example":{"value":{"messageId":"3425151601"},"id":"paths/~1api~1services~1send/post/responses/200/content/application~1json/example"},"paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidInput":{"value":{"type":"ConstraintViolationException","code":3,"message":"Parameter 'template' must not be empty and > 0"},"key":"invalidInput","summary":"Invalid input","id":"paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidInput"},"paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidTemplate":{"value":{"type":"InvalidTemplateException","code":7,"message":"Template not found or not approved"},"key":"invalidTemplate","summary":"Invalid template","id":"paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/invalidTemplate"},"paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/wrongNumber":{"value":{"type":"WrongNumberException","code":8,"message":"NO_VALID_RECIPIENT"},"key":"wrongNumber","summary":"Wrong destination number","id":"paths/~1api~1services~1send/post/responses/400/content/application~1json/examples/wrongNumber"},"paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidCredentials":{"value":{"type":"AuthenticationFailedException","code":1,"message":"Invalid credentials"},"key":"invalidCredentials","summary":"Invalid credentials","id":"paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidCredentials"},"paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/missingApiKey":{"value":{"type":"MissingApiKeyException","code":9,"message":"Missing API key"},"key":"missingApiKey","summary":"Missing API key","id":"paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/missingApiKey"},"paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidApiKey":{"value":{"type":"InvalidApiKeyException","code":9,"message":"Invalid API Key"},"key":"invalidApiKey","summary":"Invalid API key","id":"paths/~1api~1services~1send/post/responses/401/content/application~1json/examples/invalidApiKey"},"paths/~1api~1services~1send/post/responses/403/content/application~1json/examples/forbidden":{"value":{"type":"ForbiddenException","code":6,"message":"Current role [USER], missing role [ADMIN, TEMPLATE_ADMIN]"},"key":"forbidden","summary":"Insufficient role","id":"paths/~1api~1services~1send/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1api~1services~1send-otp/post/requestBody/content/application~1json/example":{"value":{"to":"+390000000000","language":"it","templateId":1,"otp":"123456","reference":{"service":"DIGITALSIGN","action":"2FA","key":"ext-key-002"}},"id":"paths/~1api~1services~1send-otp/post/requestBody/content/application~1json/example"},"paths/~1api~1services~1send-otp/post/responses/200/content/application~1json/example":{"value":{"messageId":"3425151601"},"id":"paths/~1api~1services~1send-otp/post/responses/200/content/application~1json/example"},"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/missingOtp":{"value":{"type":"ConstraintViolationException","code":3,"message":"Parameter 'otp' must not be empty"},"key":"missingOtp","summary":"Missing OTP code","id":"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/missingOtp"},"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/invalidTemplateId":{"value":{"type":"ConstraintViolationException","code":3,"message":"Template ID not valid"},"key":"invalidTemplateId","summary":"Invalid template ID","id":"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/invalidTemplateId"},"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/wrongNumber":{"value":{"type":"WrongNumberException","code":8,"message":"NO_VALID_RECIPIENT"},"key":"wrongNumber","summary":"Wrong destination number","id":"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/wrongNumber"},"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/templateNotFound":{"value":{"type":"InvalidTemplateException","code":7,"message":"Invalid template"},"key":"templateNotFound","summary":"Template not found","id":"paths/~1api~1services~1send-otp/post/responses/400/content/application~1json/examples/templateNotFound"},"paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidCredentials":{"value":{"type":"AuthenticationFailedException","code":1,"message":"Invalid credentials"},"key":"invalidCredentials","summary":"Invalid credentials","id":"paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidCredentials"},"paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/missingApiKey":{"value":{"type":"MissingApiKeyException","code":9,"message":"Missing API key"},"key":"missingApiKey","summary":"Missing API key","id":"paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/missingApiKey"},"paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidApiKey":{"value":{"type":"InvalidApiKeyException","code":9,"message":"Invalid API Key"},"key":"invalidApiKey","summary":"Invalid API key","id":"paths/~1api~1services~1send-otp/post/responses/401/content/application~1json/examples/invalidApiKey"},"paths/~1api~1template~1create/post/responses/400/content/application~1json/examples/invalidCategory":{"value":{"type":"ConstraintViolationException","code":3,"message":"Allowed category are: UTILITY, MARKETING","errorDetails":[{"field":"createTemplate.template.validCategory","message":"Allowed category are: UTILITY, MARKETING"}]},"key":"invalidCategory","summary":"Invalid category","id":"paths/~1api~1template~1create/post/responses/400/content/application~1json/examples/invalidCategory"},"paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/utilityTemplate":{"value":{"body":{"text":"Questa notifica conferma che il plugin è stato configurato correttamente."},"urlButtons":[],"textHeader":{"text":"Notifica di prova"},"language":"it","status":"APPROVED","category":"UTILITY","name":"example_utility_template","description":"Test notification","templateId":"2","default":false},"key":"utilityTemplate","summary":"Utility template","id":"paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/utilityTemplate"},"paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/authenticationTemplate":{"value":{"body":{"text":"*{{1}}* è il tuo codice di verifica. Per garantire la tua sicurezza, ti consigliamo di non condividere questo codice.","parameters":[{"text":"123456"}]},"urlButtons":[{"index":0,"urlPath":"123456","url":"https://www.whatsapp.com/otp/code/?otp_type=COPY_CODE&code_expiration_minutes=10&code=otp{{1}}","text":"Copia codice"}],"footer":{"text":"Scade tra 10 minuti.","codeExpirationMinutes":10},"language":"it","status":"APPROVED","category":"AUTHENTICATION","name":"authentication_template","description":"auth","templateId":"1","default":false},"key":"authenticationTemplate","summary":"Authentication template","id":"paths/~1api~1template~1{templateId}/get/responses/200/content/application~1json/examples/authenticationTemplate"},"paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidCredentials":{"value":{"type":"AuthenticationFailedException","code":1,"message":"Invalid credentials"},"key":"invalidCredentials","summary":"Invalid credentials","id":"paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidCredentials"},"paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/missingApiKey":{"value":{"type":"MissingApiKeyException","code":9,"message":"Missing API key"},"key":"missingApiKey","summary":"Missing API key","id":"paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/missingApiKey"},"paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidApiKey":{"value":{"type":"InvalidApiKeyException","code":9,"message":"Invalid API Key"},"key":"invalidApiKey","summary":"Invalid API key","id":"paths/~1api~1template~1{templateId}/get/responses/401/content/application~1json/examples/invalidApiKey"},"paths/~1api~1template~1{templateId}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"type":"ForbiddenException","code":6,"message":"Current role [USER], missing role [ADMIN, TEMPLATE_ADMIN]"},"key":"forbidden","summary":"Insufficient role","id":"paths/~1api~1template~1{templateId}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1api~1template~1{templateId}/get/responses/404/content/application~1json/example":{"value":{"type":"UnavailableTemplateException","code":7,"message":"Invalid template"},"id":"paths/~1api~1template~1{templateId}/get/responses/404/content/application~1json/example"},"paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/languageExists":{"value":{"type":"InvalidLanguageException","code":14,"message":"The language 'en' already exists for template '61'"},"key":"languageExists","summary":"Language already exists","id":"paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/languageExists"},"paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/invalidLanguage":{"value":{"type":"ClientWebApplicationException","code":12,"message":"Invalid parameter"},"key":"invalidLanguage","summary":"Language not supported by Meta","id":"paths/~1api~1template~1{templateId}~1language/post/responses/400/content/application~1json/examples/invalidLanguage"},"paths/~1api~1template~1{templateId}~1language/post/responses/404/content/application~1json/example":{"value":{"type":"UnavailableTemplateException","code":7,"message":"Template not found"},"id":"paths/~1api~1template~1{templateId}~1language/post/responses/404/content/application~1json/example"},"paths/~1api~1template~1{templateId}~1languages/get/responses/403/content/application~1json/examples/forbidden":{"value":{"type":"ForbiddenException","code":6,"message":"Current role [USER], missing role [ADMIN, TEMPLATE_ADMIN]"},"key":"forbidden","summary":"Insufficient role","id":"paths/~1api~1template~1{templateId}~1languages/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1api~1template~1{templateId}~1languages/get/responses/404/content/application~1json/example":{"value":{"type":"UnavailableTemplateException","code":7,"message":"Invalid template"},"id":"paths/~1api~1template~1{templateId}~1languages/get/responses/404/content/application~1json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(username:password)"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive username and password via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Key authentication using account credentials."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: YOUR_API_KEY"},"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":"How to obtain credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"Contact Namirial support to create a WhatsApp Gateway account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive API key via secure channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test credentials in TEST environment first"},"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":"link","inline":true,"attributes":{"href":"https://docs.namirial.app/products/whatsapp/enterprise-documentation/developer-documentation/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"in":"header","paramName":"X-Api-Key"}},"specVersion":"3.1.0","servers":[{"url":"https://wa.namirialtsp.com","description":"Production environment"},{"url":"https://wa.test.namirialtsp.com","description":"Testing environment"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/whatsapp/openapi.json?download"},{"url":"/_bundle/products/whatsapp/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Namirial WhatsApp Gateway API","description":"API for sending WhatsApp messages via the Namirial WhatsApp Gateway. Supports template-based messaging, OTP delivery, and template management.\n\nAuthentication requires both Basic Auth credentials and an API key header (`X-Api-Key`). See the [Authentication](#section/Authentication) section for details."}},"baseSlug":"/products/whatsapp/openapi","routesMapping":{}}