{"items":[{"type":"link","label":"Namirial SMS Gateway API","link":"/it/products/sms/openapi","routeSlug":"/it/products/sms/openapi","content":{"contentType":"overview","meta":{"name":"Namirial SMS Gateway API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/@l10n/it/products/sms/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/@l10n/it/products/sms/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://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Namirial SMS Gateway API (27.3.1.6)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Send SMS messages worldwide with enterprise-grade reliability and delivery tracking."}],"sectionId":"/"},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/sms/homepage","description":"Complete SMS Gateway Documentation"}],"sectionId":"/"}]}]}},{"type":"group","label":"SmsServices","link":"/it/products/sms/openapi/smsservices","routeSlug":"/it/products/sms/openapi/smsservices","items":[{"label":"Check service health","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/sms/openapi/smsservices/checkservicestatus","routeSlug":"/it/products/sms/openapi/smsservices/checkservicestatus","metadata":{"seo":{"title":"Check service health","description":"Health check endpoint to verify SMS Gateway availability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkServiceStatus","name":"Check service health","isWebhook":false,"pointer":"/paths/~1api~1Services~1checkServiceStatus/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check service health","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":"Health check endpoint to verify SMS Gateway availability."},"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":"Use case"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Monitor service status before sending SMS or in health check routines."},"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":"Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POST with empty body (no parameters required)"},"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":"Response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": HTTP 200 if service is operational"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/Services/checkServiceStatus","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/Services/checkServiceStatus","href":"smsservices/checkservicestatus","openApiOperationId":"checkServiceStatus","summary":"Check service health"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and 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":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1checkServiceStatus/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1checkServiceStatus/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1Services~1checkServiceStatus/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1checkServiceStatus/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1checkServiceStatus/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smsservices/checkservicestatus"}],"panels":[]}]},"httpPath":"/api/Services/checkServiceStatus"},{"label":"Send SMS message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/sms/openapi/smsservices/sendsms","routeSlug":"/it/products/sms/openapi/smsservices/sendsms","metadata":{"seo":{"title":"Send SMS message","description":"Send an SMS message to a destination phone number using your account credentials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendSms","name":"Send SMS message","isWebhook":false,"pointer":"/paths/~1api~1Services~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send SMS 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":"Send an SMS message to a destination phone number using your 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":"Use case"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Standard SMS sending for your applications (2FA, notifications, alerts)."},"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":"Delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Messages are queued and sent asynchronously. Use webhooks or Message Status API to track delivery."},"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":"Character limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GSM-7 encoding: 160 chars"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCS-2 encoding: 70 chars"},"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 an SMS 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/sms/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","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServicesSendRequestBody","exampleIds":["paths/~1api~1Services~1send/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ServicesSendRequestBody","exampleIds":["paths/~1api~1Services~1send/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1Services~1send/post/requestBody","description":"Send parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/Services/send","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServicesSendRequestBody","exampleIds":["paths/~1api~1Services~1send/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","500"],"pointer":"/api/Services/send","href":"smsservices/sendsms","openApiOperationId":"sendSms","summary":"Send SMS message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"schemaId":"components/schemas/ServicesSendRequestBody","exampleIds":["paths/~1api~1Services~1send/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServicesSendRequestBody","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":"SMS accepted for delivery.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted-detailed"]}},"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted-detailed"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/NOT_VALID"]}},"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/NOT_VALID"]},{"code":"500","description":"Application error. Invalid parameter values may result in HTTP 500.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"]}},"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"]}],"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/examples/accepted","paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted-detailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted-detailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/NOT_VALID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/NOT_VALID"]}}},{"code":"500","schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smsservices/sendsms"}],"panels":[]}]},"httpPath":"/api/Services/send"},{"label":"Get service status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/sms/openapi/smsservices/getservicesstatus","routeSlug":"/it/products/sms/openapi/smsservices/getservicesstatus","metadata":{"seo":{"title":"Get service status","description":"Get detailed service status information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServicesStatus","name":"Get service status","isWebhook":false,"pointer":"/paths/~1api~1Services~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get service status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get detailed service status information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/Services/status","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/Services/status","href":"smsservices/getservicesstatus","openApiOperationId":"getServicesStatus","summary":"Get service status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and 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":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1status/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1Services~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Services~1status/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smsservices/getservicesstatus"}],"panels":[]}]},"httpPath":"/api/Services/status"}],"content":{"contentType":"group","meta":{"name":"SmsServices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SmsServices","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send SMS messages using your 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":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": HTTP Basic Auth required"},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/sms/enterprise-documentation/developer-documentation/api-references/services-send","description":"SMS Services Documentation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/Services/checkServiceStatus","summary":"Check service health","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smsservices/checkservicestatus","deprecated":false},{"title":"/api/Services/send","summary":"Send SMS message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smsservices/sendsms","deprecated":false},{"title":"/api/Services/status","summary":"Get service status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/smsservices/getservicesstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"SmsAdmin","link":"/it/products/sms/openapi/smsadmin","routeSlug":"/it/products/sms/openapi/smsadmin","items":[{"label":"Check service health (admin)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/sms/openapi/smsadmin/admincheckservicestatus","routeSlug":"/it/products/sms/openapi/smsadmin/admincheckservicestatus","metadata":{"seo":{"title":"Check service health (admin)","description":"Admin health check endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"adminCheckServiceStatus","name":"Check service health (admin)","isWebhook":false,"pointer":"/paths/~1api~1Admin~1checkServiceStatus/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check service health (admin)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Admin health check endpoint"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/Admin/checkServiceStatus","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/Admin/checkServiceStatus","href":"smsadmin/admincheckservicestatus","openApiOperationId":"adminCheckServiceStatus","summary":"Check service health (admin)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and 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":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1checkServiceStatus/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1checkServiceStatus/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1Admin~1checkServiceStatus/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1checkServiceStatus/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1checkServiceStatus/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smsadmin/admincheckservicestatus"}],"panels":[]}]},"httpPath":"/api/Admin/checkServiceStatus"},{"label":"Send SMS with admin privileges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/sms/openapi/smsadmin/adminsendsms","routeSlug":"/it/products/sms/openapi/smsadmin/adminsendsms","metadata":{"seo":{"title":"Send SMS with admin privileges","description":"Send an SMS message on behalf of another account using admin credentials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"adminSendSms","name":"Send SMS with admin privileges","isWebhook":false,"pointer":"/paths/~1api~1Admin~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send SMS with admin privileges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send an SMS message on behalf of another account using admin 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":"Use case"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Send SMS for other accounts without their 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":"Additional parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Local Registration Authority)"},"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 an SMS 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/sms/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","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminSendRequestBody","exampleIds":["paths/~1api~1Admin~1send/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AdminSendRequestBody","exampleIds":["paths/~1api~1Admin~1send/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1Admin~1send/post/requestBody","description":"Send parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/Admin/send","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AdminSendRequestBody","exampleIds":["paths/~1api~1Admin~1send/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","500"],"pointer":"/api/Admin/send","href":"smsadmin/adminsendsms","openApiOperationId":"adminSendSms","summary":"Send SMS with admin privileges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"schemaId":"components/schemas/AdminSendRequestBody","exampleIds":["paths/~1api~1Admin~1send/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminSendRequestBody","exampleIds":["paths/~1api~1Admin~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":"SMS accepted for delivery.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted-detailed"]}},"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted-detailed"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/NOT_VALID"]}},"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/NOT_VALID"]},{"code":"403","description":"Access denied. The authenticated account does not have Admin privileges.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/403/content/application~1json/example"]},{"code":"500","description":"Application error. Invalid parameter values may result in HTTP 500.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/INVALID_ACCOUNT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"]}},"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/INVALID_ACCOUNT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"]}],"pointer":"/paths/~1api~1Admin~1send/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted-detailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendResponse","exampleIds":["paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted","paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted-detailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/NOT_VALID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/MISSING","paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/NOT_VALID"]}}},{"code":"403","schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/403/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/INVALID_ACCOUNT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorInfo","exampleIds":["paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/INVALID_ACCOUNT","paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smsadmin/adminsendsms"}],"panels":[]}]},"httpPath":"/api/Admin/send"},{"label":"Get admin service status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/sms/openapi/smsadmin/getadminstatus","routeSlug":"/it/products/sms/openapi/smsadmin/getadminstatus","metadata":{"seo":{"title":"Get admin service status","description":"Get detailed admin service status information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAdminStatus","name":"Get admin service status","isWebhook":false,"pointer":"/paths/~1api~1Admin~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get admin service status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get detailed admin service status information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/Admin/status","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/Admin/status","href":"smsadmin/getadminstatus","openApiOperationId":"getAdminStatus","summary":"Get admin service status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and 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":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1status/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1Admin~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceStatusResponse","exampleIds":["paths/~1api~1Admin~1status/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smsadmin/getadminstatus"}],"panels":[]}]},"httpPath":"/api/Admin/status"}],"content":{"contentType":"group","meta":{"name":"SmsAdmin"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SmsAdmin","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send SMS with administrative privileges on behalf of other accounts."},"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":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": HTTP Basic Auth required"},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://docs.namirial.app/products/sms/enterprise-documentation/developer-documentation/api-references/admin-send","description":"Admin API Documentation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/Admin/checkServiceStatus","summary":"Check service health (admin)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smsadmin/admincheckservicestatus","deprecated":false},{"title":"/api/Admin/send","summary":"Send SMS with admin privileges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smsadmin/adminsendsms","deprecated":false},{"title":"/api/Admin/status","summary":"Get admin service status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/smsadmin/getadminstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AdminSendRequestBody":{"id":"components/schemas/AdminSendRequestBody","kind":"json-schema","title":"AdminSendRequestBody","data":{"type":"object","properties":{"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination phone number in E.164 international format."},"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":"+[country code][number]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+393401234567"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"pattern":"^\\+[1-9]\\d{6,14}$","example":"+390000000000"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message text to send."},"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":"Character limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GSM-7: 160 chars (single), 153 chars (multi-part)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCS-2: 70 chars (single), 67 chars (multi-part)"},"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":"Encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Automatically detected"},"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":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Emojis trigger UCS-2 (higher cost)"},"children":[]}]}]}],"minLength":1,"maxLength":1600},"reference":{"$ref":"#/components/schemas/ReferenceService"},"attemptCount":{"format":"int32","type":"integer","deprecated":true,"description":[{"$$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":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No longer used. Retry logic is handled automatically."},"children":[]}]}]}]},"detailed":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return detailed response including provider name."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Response includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Response without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider"},"children":[]}]}]}]}]},"businessRelationId":{"type":"string","maxLength":255,"description":"Business Relation Identifier for One Platform integration.\n\nOverrides default business relation settings."},"webhook":{"allOf":[{"$ref":"#/components/schemas/ClientWebhookData"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook configuration for delivery status notifications."},"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/sms/enterprise-documentation/developer-documentation/wb/wb-configuration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]},"account":{"type":"string","description":"Target account username to send SMS on behalf of"},"lra":{"type":"string","description":"Local Registration Authority identifier"}},"required":["destination","text"]}},"components/schemas/ClientWebhookAuth":{"id":"components/schemas/ClientWebhookAuth","kind":"json-schema","title":"ClientWebhookAuth","data":{"type":"object","properties":{"type":{"type":"string","description":"Authentication type","enum":["NONE","JWS"]},"value":{"type":"string","description":""}},"description":"Authentication for webhook requests"}},"components/schemas/ClientWebhookData":{"id":"components/schemas/ClientWebhookData","kind":"json-schema","title":"ClientWebhookData","data":{"type":"object","properties":{"url":{"type":"string","description":"Webhook endpoint URL (must be HTTPS)","format":"uri"},"authentication":{"$ref":"#/components/schemas/ClientWebhookAuth"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook configuration for delivery status notifications."},"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/sms/enterprise-documentation/developer-documentation/wb/wb-configuration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}},"components/schemas/ErrorInfo":{"id":"components/schemas/ErrorInfo","kind":"json-schema","title":"ErrorInfo","data":{"type":"object","properties":{"code":{"format":"int32","type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code."},"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/sms/enterprise-documentation/developer-documentation/integration-guide/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for complete list."},"children":[]}]}]}],"enum":[8,56,59,60,61,63,64,66,74,76],"x-enum-descriptions":{"8":"Wrong destination number format","56":"Invalid or unreachable number","59":"Invalid reference service identifier","60":"Message blocked by anti-flooding protection","61":"Destination number in watchlist (permanently blocked)","63":"Authentication error (missing or invalid credentials)","64":"SMS provider temporarily unavailable","66":"Invalid message text (empty or exceeds 1600 characters)","74":"Message contains URL but account not configured for URLs","76":"Account does not exist"}},"message":{"type":"string","description":"Human-readable error message"},"details":{"type":"array","items":{"type":"string"},"description":"Additional error details or troubleshooting hints","nullable":true}},"required":["code","message"]}},"components/schemas/ReferenceService":{"id":"components/schemas/ReferenceService","kind":"json-schema","title":"ReferenceService","data":{"type":"object","properties":{"service":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service identifier (e.g., MY_SERVICE). 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. Must match one of the predefined allowed values — 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":"."},"children":[]}]}]}],"maxLength":50},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action within the service (e.g., 2FA, PASSWORD_RESET)"},"children":[]}]}]}],"maxLength":50},"key":{"type":"string","description":"Custom tracking key (e.g., user ID, order ID)","maxLength":255}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking reference to correlate SMS with your business logic. If any field is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]}},"components/schemas/SendResponse":{"id":"components/schemas/SendResponse","kind":"json-schema","title":"SendResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique message identifier (UUID). Use to query status via Message Status API."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status message. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<code>: <description>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Code 0 = accepted."},"children":[]}]}]}]},"provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS provider used (only when detailed=true)."},"children":[]}]}]}],"nullable":true}},"required":["id","message"]}},"components/schemas/ServicesSendRequestBody":{"id":"components/schemas/ServicesSendRequestBody","kind":"json-schema","title":"ServicesSendRequestBody","data":{"type":"object","properties":{"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination phone number in E.164 international format."},"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":"+[country code][number]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+393401234567"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"pattern":"^\\+[1-9]\\d{6,14}$","example":"+390000000000"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message text to send."},"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":"Character limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GSM-7: 160 chars (single), 153 chars (multi-part)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCS-2: 70 chars (single), 67 chars (multi-part)"},"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":"Encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Automatically detected"},"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":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Emojis trigger UCS-2 (higher cost)"},"children":[]}]}]}],"minLength":1,"maxLength":1600},"reference":{"$ref":"#/components/schemas/ReferenceService"},"attemptCount":{"format":"int32","type":"integer","deprecated":true,"description":[{"$$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":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No longer used. Retry logic is handled automatically."},"children":[]}]}]}]},"detailed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return detailed response including provider name."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Response includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Response without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider"},"children":[]}]}]}]}],"default":false},"businessRelationId":{"type":"string","description":"Business Relation Identifier for One Platform integration.\n\nOverrides default business relation settings.","maxLength":255},"webhook":{"allOf":[{"$ref":"#/components/schemas/ClientWebhookData"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook configuration for delivery status notifications."},"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/sms/enterprise-documentation/developer-documentation/wb/wb-configuration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}},"required":["destination","text"]}},"components/schemas/ServiceStatusResponse":{"id":"components/schemas/ServiceStatusResponse","kind":"json-schema","title":"ServiceStatusResponse","data":{"type":"object","required":["globalStatus","dbStatus","servicesStatus","versionNumber"],"properties":{"globalStatus":{"type":"boolean","description":"Overall service availability."},"dbStatus":{"type":"boolean","description":"Database connectivity status."},"servicesStatus":{"type":"boolean","description":"Internal services availability."},"errorMessage":{"type":"string","description":"Error message if any component is unavailable. Empty string when all systems are operational."},"versionNumber":{"type":"string","description":"Current API version.","example":"27.1.0.2"}}}}},"exampleStore":{"paths/~1api~1Services~1checkServiceStatus/post/responses/200/content/application~1json/example":{"value":{"globalStatus":true,"dbStatus":true,"servicesStatus":true,"errorMessage":"","versionNumber":"27.1.0.2"},"id":"paths/~1api~1Services~1checkServiceStatus/post/responses/200/content/application~1json/example"},"paths/~1api~1Services~1send/post/requestBody/content/application~1json/example":{"value":{"destination":"+390000000000","text":"Your verification code is: 123456","reference":{"service":"SPID","action":"VERIFICATION","key":"123123456456"},"businessRelationId":"123456789","webhook":{"url":"https://example.com/webhook"},"detailed":false},"id":"paths/~1api~1Services~1send/post/requestBody/content/application~1json/example"},"paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted":{"value":{"id":"7b8ef313-f1f2-4c4f-bffa-438c287ba9d8","message":"0: Accepted for delivery"},"key":"accepted","summary":"SMS accepted (detailed=false)","id":"paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted"},"paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted-detailed":{"value":{"id":"be67210b-072a-40b2-9278-014caeba6bc9","message":"0: Accepted for delivery","provider":"PROVIDER1"},"key":"accepted-detailed","summary":"SMS accepted (detailed=true)","id":"paths/~1api~1Services~1send/post/responses/200/content/application~1json/examples/accepted-detailed"},"paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/MISSING":{"value":{"code":63,"message":"Missing basic authentication header"},"key":"MISSING","summary":"MISSING","id":"paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/MISSING"},"paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/NOT_VALID":{"value":{"code":63,"message":"Username or password not valid"},"key":"NOT_VALID","summary":"NOT_VALID","id":"paths/~1api~1Services~1send/post/responses/401/content/application~1json/examples/NOT_VALID"},"paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER":{"value":{"code":8,"message":"Wrong number error"},"key":"WRONG_NUMBER","summary":"WRONG_NUMBER","id":"paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER"},"paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT":{"value":{"code":66,"message":"Empty or missing message text","details":null},"key":"EMPTY_TEXT","summary":"EMPTY_TEXT","id":"paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT"},"paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH":{"value":{"code":66,"message":"Message text exceeds maximum length of 1600 characters","details":null},"key":"MAX_LENGTH","summary":"MAX_LENGTH","id":"paths/~1api~1Services~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"},"paths/~1api~1Services~1status/get/responses/200/content/application~1json/example":{"value":{"globalStatus":true,"dbStatus":true,"servicesStatus":true,"errorMessage":"","versionNumber":"27.1.0.2"},"id":"paths/~1api~1Services~1status/get/responses/200/content/application~1json/example"},"paths/~1api~1Admin~1checkServiceStatus/post/responses/200/content/application~1json/example":{"value":{"globalStatus":true,"dbStatus":true,"servicesStatus":true,"errorMessage":"","versionNumber":"27.1.0.2"},"id":"paths/~1api~1Admin~1checkServiceStatus/post/responses/200/content/application~1json/example"},"paths/~1api~1Admin~1send/post/requestBody/content/application~1json/example":{"value":{"destination":"+390000000000","text":"Your verification code is: 123456","account":"account-username","lra":123456,"reference":{"service":"DIGITALSIGN","action":"AUTH","key":"dfg6hwrt356hd"},"businessRelationId":"123456789","webhook":{"url":"https://example.com/webhook"},"detailed":true},"id":"paths/~1api~1Admin~1send/post/requestBody/content/application~1json/example"},"paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted":{"value":{"id":"7b8ef313-f1f2-4c4f-bffa-438c287ba9d8","message":"0: Accepted for delivery"},"key":"accepted","summary":"SMS accepted (detailed=false)","id":"paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted"},"paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted-detailed":{"value":{"id":"be67210b-072a-40b2-9278-014caeba6bc9","message":"0: Accepted for delivery","provider":"PROVIDER1"},"key":"accepted-detailed","summary":"SMS accepted (detailed=true)","id":"paths/~1api~1Admin~1send/post/responses/200/content/application~1json/examples/accepted-detailed"},"paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/MISSING":{"value":{"code":63,"message":"Missing basic authentication header"},"key":"MISSING","summary":"MISSING","id":"paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/MISSING"},"paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/NOT_VALID":{"value":{"code":63,"message":"Username or password not valid"},"key":"NOT_VALID","summary":"NOT_VALID","id":"paths/~1api~1Admin~1send/post/responses/401/content/application~1json/examples/NOT_VALID"},"paths/~1api~1Admin~1send/post/responses/403/content/application~1json/example":{"value":{"code":63,"message":"User user_test not authorized for webmethod send","details":null},"id":"paths/~1api~1Admin~1send/post/responses/403/content/application~1json/example"},"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER":{"value":{"code":8,"message":"Wrong number error"},"key":"WRONG_NUMBER","summary":"WRONG_NUMBER","id":"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/WRONG_NUMBER"},"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT":{"value":{"code":66,"message":"Empty or missing message text","details":null},"key":"EMPTY_TEXT","summary":"EMPTY_TEXT","id":"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/EMPTY_TEXT"},"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/INVALID_ACCOUNT":{"value":{"code":76,"message":"Account nonexistent_account does not exist","details":null},"key":"INVALID_ACCOUNT","summary":"INVALID_ACCOUNT","id":"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/INVALID_ACCOUNT"},"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH":{"value":{"code":66,"message":"Message text exceeds maximum length of 1600 characters","details":null},"key":"MAX_LENGTH","summary":"MAX_LENGTH","id":"paths/~1api~1Admin~1send/post/responses/500/content/application~1json/examples/MAX_LENGTH"},"paths/~1api~1Admin~1status/get/responses/200/content/application~1json/example":{"value":{"globalStatus":true,"dbStatus":true,"servicesStatus":true,"errorMessage":"","versionNumber":"27.1.0.2"},"id":"paths/~1api~1Admin~1status/get/responses/200/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 an SMS 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/sms/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":[]}]}]}]}},"specVersion":"3.0.3","servers":[{"url":"https://sms.namirialtsp.com","description":"Production environment"},{"url":"https://sms.preprod.namirialtsp.com","description":"Pre-production staging environment (coming soon)"},{"url":"https://sms.test.namirialtsp.com","description":"Development and testing environment"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/it/products/sms/openapi.json?download"},{"url":"/_bundle/@l10n/it/products/sms/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Namirial SMS Gateway API","description":"Send SMS messages worldwide with enterprise-grade reliability and delivery tracking."}},"baseSlug":"/it/products/sms/openapi","routesMapping":{}}