{"info":{"_postman_id":"3ca350c2-a259-40a5-81ea-3c230bdcdffe","name":"Notice API Documentation","description":"<html><head></head><body><p>API for SMS, Audio, and WhatsApp sending and retrieval.</p>\n<p>Get your Bearer token from <a href=\"https://app.notice.ro/dashboard/api\">https://app.notice.ro/dashboard/api</a></p>\n<h3 id=\"php-sdk\">PHP SDK</h3>\n<p><a href=\"https://github.com/noticero/notice-sdk-php\">https://github.com/noticero/notice-sdk-php</a></p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6644801","collectionId":"3ca350c2-a259-40a5-81ea-3c230bdcdffe","publishedId":"2s9YyzbxNU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-08T19:15:48.000Z"},"item":[{"name":"AUTH","item":[{"name":"Login","id":"eae50df3-125a-438a-a0ab-527ef8085248","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"your@email.com\",\n  \"password\": \"yourpassword\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notice.ro/api/v1/login","description":"<p>Returns a short-lived access token with <code>issue-access-token</code> ability. Use this token to call <strong>Issue SMS Token</strong>.</p>\n<p>Store the returned <code>token</code> value in the <code>access_token</code> collection variable.</p>\n","urlObject":{"path":["login"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"eae50df3-125a-438a-a0ab-527ef8085248"},{"name":"Issue SMS Token","id":"c5138be9-8ae1-42d9-838a-81896342efeb","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/auth/sms-token","description":"<p>Issues a long-lived token with <code>sms-api</code> ability. Required for sending SMS, WhatsApp messages, and reading inbox/outbox.</p>\n<p>Store the returned <code>token</code> value in the <code>sms_token</code> collection variable.</p>\n","urlObject":{"path":["auth","sms-token"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5138be9-8ae1-42d9-838a-81896342efeb"}],"id":"dfbef794-2a94-4b68-9526-7524e1f66903","description":"<p>Authentication flow. Call Login first, then Issue SMS Token to get the token used by all other endpoints.</p>\n","_postman_id":"dfbef794-2a94-4b68-9526-7524e1f66903"},{"name":"SMS","item":[{"name":"GET SMS","id":"d0bd4af7-e6f0-47be-991b-e0e6bc9e3ced","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept-Encoding","value":"application/json","type":"text"}],"url":"https://api.notice.ro/api/v1/sms-in","description":"<p>This endpoint makes an HTTP GET request to retrieve SMS messages...</p>\n","urlObject":{"path":["sms-in"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0bd4af7-e6f0-47be-991b-e0e6bc9e3ced"},{"name":"SEND SMS","id":"98067b32-680a-4dda-bd61-dcfacbee8f45","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"number","value":"07XXXXXXXX","type":"text","description":"<p>Any Romanian formatted number eg: 07XXXXXXXX</p>\n"},{"key":"message","value":"hello world!","type":"text","description":"<p>Your 130 chars message</p>\n"}]},"url":"https://api.notice.ro/api/v1/sms-out","urlObject":{"path":["sms-out"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"98067b32-680a-4dda-bd61-dcfacbee8f45"},{"name":"SMS RESEND","id":"9865e14f-c371-4a4f-8842-b12e3414cf47","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"sms[]","value":"1","type":"text"}]},"url":"https://api.notice.ro/api/v1/sms-out/resendsms","urlObject":{"path":["sms-out","resendsms"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"9865e14f-c371-4a4f-8842-b12e3414cf47"},{"name":"DELETE SMS","id":"8058054c-5478-43c6-bc83-e129214b49d3","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"sms[]","value":"1","type":"text","description":"<p>ID of sms</p>\n"},{"key":"sms[]","value":"3","type":"text"},{"key":"sms[]","value":"99","type":"text"}]},"url":"https://api.notice.ro/api/v1/sms-out/1","urlObject":{"path":["sms-out","1"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"8058054c-5478-43c6-bc83-e129214b49d3"}],"id":"d9338630-5077-40c3-bf8a-24f1a7c71b9a","_postman_id":"d9338630-5077-40c3-bf8a-24f1a7c71b9a","description":""},{"name":"TEMPLATES","item":[{"name":"GET TEMPLATES","id":"387d36a3-7eda-45bf-a633-2b5342f388f0","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.notice.ro/api/v1/templates/","urlObject":{"path":["templates",""],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"387d36a3-7eda-45bf-a633-2b5342f388f0"},{"name":"ADD TEMPLATE","id":"442c31c4-c1c4-4069-b74f-074064249871","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Template 1","type":"text"},{"key":"text","value":"Your {order_id} has been received.","type":"text"}]},"url":"https://api.notice.ro/api/v1/templates","urlObject":{"path":["templates"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"442c31c4-c1c4-4069-b74f-074064249871"},{"name":"UPDATE TEMPLATE","id":"48f74ca0-001a-49be-8f0d-f7a3b853e3f7","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Test123323213123","type":"text"},{"key":"text","value":"","type":"text"}]},"url":"https://api.notice.ro/api/v1/template/1","urlObject":{"path":["template","1"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"48f74ca0-001a-49be-8f0d-f7a3b853e3f7"},{"name":"DELETE TEMPLATE","id":"b4ccaf6f-b3cf-46d0-8f85-8b6c1fb20206","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.notice.ro/api/v1/templates/10","urlObject":{"path":["templates","10"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4ccaf6f-b3cf-46d0-8f85-8b6c1fb20206"}],"id":"bc8624cb-62da-4536-8251-b74f5adb3381","description":"<p>Manage your notification templates. Current variables allowed are: <code>'{name}', '{order_id}', '{telephone}', '{email}', '{total}', '{store_url}', '{date_added}', '{shipping_company}', '{shipping_address}', '{shipping_postcode}', '{shipping_city}', '{shipping_region}', '{shipping_country}', '{payment_company}', '{payment_address}', '{payment_postcode}', '{payment_city}', '{payment_region}', '{payment_country}', '{payment_method}', '{shipping_method}', '{site}', '{url}'</code></p>\n","_postman_id":"bc8624cb-62da-4536-8251-b74f5adb3381"},{"name":"AUDIO","item":[{"name":"GET AUDIO LIST","id":"29ea4f0f-b24d-47fe-a8c4-8815e5d428c5","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.notice.ro/api/v1/audio/","urlObject":{"path":["audio",""],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"29ea4f0f-b24d-47fe-a8c4-8815e5d428c5"},{"name":"SEND AUDIO","id":"4d734945-49e0-4f47-9e99-dff34aefe2dd","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"number","value":"07XXXXXXXX","type":"text"},{"key":"text","value":"Hi this is my text","type":"text"},{"key":"type","value":"confirmation|fulfilment|draft","type":"text"},{"key":"callback_url","value":"https://yourwebsite.com","type":"text"}]},"url":"https://api.notice.ro/api/v1/audio","urlObject":{"path":["audio"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d734945-49e0-4f47-9e99-dff34aefe2dd"}],"id":"9cac152f-1923-42ea-871e-4a93fc444d35","_postman_id":"9cac152f-1923-42ea-871e-4a93fc444d35","description":""},{"name":"WHATSAPP","item":[{"name":"Devices","item":[{"name":"List Devices","id":"0383205d-a4ae-4abb-b8e3-c10052b9f6ed","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/devices","description":"<p>Returns all WhatsApp devices owned by the authenticated user.</p>\n","urlObject":{"path":["whatsapp","devices"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"0383205d-a4ae-4abb-b8e3-c10052b9f6ed"},{"name":"Register Device","id":"7a366b79-4e7c-4a1c-904a-27dc347b3cd2","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"device_name\": \"My Phone\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notice.ro/api/v1/whatsapp/devices","description":"<p>Creates a new device session. Returns the device <code>id</code> and a <code>qr_code</code> string to render as a QR image.</p>\n<p>Store the returned <code>id</code> in the <code>device_id</code> variable.</p>\n","urlObject":{"path":["whatsapp","devices"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a366b79-4e7c-4a1c-904a-27dc347b3cd2"},{"name":"Get Device","id":"f00bb068-ed93-4fd1-a6ec-f280656411c7","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/devices/","description":"<p><code>qr_code</code> is only included in the response when <code>status</code> is <code>pending</code>.</p>\n","urlObject":{"path":["whatsapp","devices",""],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"f00bb068-ed93-4fd1-a6ec-f280656411c7"},{"name":"Refresh QR Code","id":"5385789d-f83a-473e-b99c-82a460c98e30","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/devices//qr","description":"<p>QR codes expire after ~60 seconds. Call this to get a fresh QR when the previous one times out.</p>\n<p>Only works when device <code>status</code> is <code>pending</code>.</p>\n<p><strong>Errors:</strong> <code>422</code> if not pending · <code>503</code> if external service unavailable</p>\n","urlObject":{"path":["whatsapp","devices","","qr"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"5385789d-f83a-473e-b99c-82a460c98e30"},{"name":"Request Pairing Code","id":"543ea125-5b9d-4691-bb23-fde60d67d98b","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"phone_number\": \"+40712345678\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notice.ro/api/v1/whatsapp/devices//pairing-code","description":"<p>Alternative to QR scan. Returns a 6-character code tied to the given phone number.</p>\n<p>The user opens WhatsApp → <strong>Linked Devices</strong> → <strong>Link with phone number</strong> → enters the code.</p>\n<p>Only works when device <code>status</code> is <code>pending</code>.</p>\n<p><strong>Errors:</strong> <code>422</code> if not pending · <code>503</code> if external service unavailable</p>\n","urlObject":{"path":["whatsapp","devices","","pairing-code"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"543ea125-5b9d-4691-bb23-fde60d67d98b"},{"name":"Poll Device Status","id":"cb67df73-399e-4138-aea1-12f81eee2ae1","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/devices//status","description":"<p>Checks the current status from the external service and updates the device record. Poll every 3-5 seconds until <code>status</code> is <code>authenticated</code>.</p>\n<p>Possible values: <code>pending</code> · <code>authenticated</code> · <code>disconnected</code> · <code>banned</code> · <code>unknown</code></p>\n<p>A device is <strong>online</strong> when status is <code>authenticated</code> and it was seen within the last 5 minutes.</p>\n","urlObject":{"path":["whatsapp","devices","","status"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb67df73-399e-4138-aea1-12f81eee2ae1"},{"name":"Delete Device","id":"d28eb14b-30f9-44af-887e-7445b332b71a","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/devices/","description":"<p>Disconnects the device session and soft-deletes the record.</p>\n","urlObject":{"path":["whatsapp","devices",""],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"d28eb14b-30f9-44af-887e-7445b332b71a"}],"id":"ae623cb6-45bf-42b1-854e-1d9ae0e25706","description":"<p>Register and manage WhatsApp devices linked to a user account. Two registration methods: QR code scan or pairing code.</p>\n","_postman_id":"ae623cb6-45bf-42b1-854e-1d9ae0e25706"},{"name":"Messages","item":[{"name":"Send Message","id":"4262c55a-226e-4f72-9412-75c897965742","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"number\": \"+40712345678\",\n  \"message\": \"Hello from the API!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.notice.ro/api/v1/whatsapp/send","description":"<p>Queues a WhatsApp message to the given number.</p>\n<p><strong>number</strong> — international format: <code>+40712345678</code> or <code>40712345678</code>. Local formats (e.g. <code>0712...</code>) are rejected.</p>\n<p><strong>Errors:</strong> <code>403</code> insufficient credits · <code>403</code> whatsapp not enabled · <code>503</code> no device available · <code>422</code> invalid number format</p>\n","urlObject":{"path":["whatsapp","send"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"4262c55a-226e-4f72-9412-75c897965742"},{"name":"Inbox (Received Messages)","id":"f4529c56-a8d7-4d81-aad5-4a48a92b36fc","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/inbox","description":"<p>Returns incoming WhatsApp messages for the authenticated user, paginated 25 per page, newest first.</p>\n","urlObject":{"path":["whatsapp","inbox"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4529c56-a8d7-4d81-aad5-4a48a92b36fc"},{"name":"Outbox (Sent Messages)","id":"671bc4d4-ac33-4b97-8644-56323b1c6699","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.notice.ro/api/v1/whatsapp/outbox","description":"<p>Returns outgoing WhatsApp messages for the authenticated user, paginated 25 per page, newest first.</p>\n<p>Message statuses: <code>queued</code> → <code>sending</code> → <code>sent</code> → <code>delivered</code> (or <code>failed</code>)</p>\n","urlObject":{"path":["whatsapp","outbox"],"host":["https://api.notice.ro/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"671bc4d4-ac33-4b97-8644-56323b1c6699"}],"id":"b6d157c9-d458-49c9-822d-7c44bd558094","description":"<p>Send WhatsApp messages and read inbox/outbox. Requires <code></code> (sms-api ability).</p>\n","_postman_id":"b6d157c9-d458-49c9-822d-7c44bd558094"}],"id":"e01e8ccd-432b-48da-939f-e64f0aabad91","description":"<p>WhatsApp messaging via linked devices.</p>\n<p><strong>Auth:</strong> Device endpoints use <code></code>. Send / inbox / outbox use <code></code>.</p>\n","_postman_id":"e01e8ccd-432b-48da-939f-e64f0aabad91"}],"variable":[{"key":"baseUrl","value":"https://api.notice.ro/api/v1","type":"string"},{"key":"access_token","value":"","type":"string"},{"key":"refresh_token","value":"","type":"string"},{"key":"sms_token","value":"","type":"string"},{"key":"device_id","value":"","type":"string"}]}