Welcome to the Relay360 API Documentation — your gateway to building reliable, high-volume communication workflows for notifications, alerts, and multi-channel campaigns across SMS, Voice, WhatsApp, and Email. Relay360 provides a unified job-processing and verification engine designed for scale, speed, and operational clarity.
\nBefore you begin, make sure the following are in place:
\nCreate a developer account on the Relay360 platform.
\nRetrieve your API key from your Relay360 dashboard.
\nFund your account with sufficient messaging and voice credits.
\nWith your setup complete, the sections ahead will walk you through authentication, request formats, channel guides, and best practices for orchestrating dependable, high-throughput communication workflows.
\nRelay360 uses standard Bearer Token authentication for all API requests.
\nInclude the Authorization header with every request you send. This header identifies your application and allows the platform to validate the request source.
\nFormat:
\nAuthorization: Bearer <YOUR_API_KEY>\n\nRelay360 accepts two primary content types:
\napplication/json — for standard requests that do not include file uploads
multipart/form-data — for requests that involve file uploads
Always set the appropriate Content-Type header based on the nature of your request.
The Relay360 production base url is https://api.relay360.dev/v1
All set? Explore the available endpoints below and start integrating Relay360 into your notification and campaign workflows.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2241118","collectionId":"892f8fc3-7c71-4bd3-862f-a425de09cb77","publishedId":"2sB3dLTrgy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"9333ea"},"publishDate":"2025-12-02T00:26:59.000Z"},"item":[{"name":"Message Dispatch","item":[{"name":"Create SMS Dispatch Job","id":"ccc504d6-60a1-4a47-bdd8-c4ea39d6cc8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"msisdns\": \"+2348124163122\",\n\"name\": \"test\",\n\"message_text\": \"Hello to you too\",\n\"external_id\": \"91b49feb-4642-5b6b-911f-4c874e202d8b\",\n\"webhook_url\": \"https://webhook.site/a27c8be1-2b90-48cc-b28e-8e4da0b2b288\"\n}"},"url":"{{BASE_URL}}/dispatch/sms","description":"This endpoint allows you to instantly send or schedule an SMS message to one or more phone numbers, or to a phonebook you’ve created on your Relay360 dashboard. All phone numbers must include the appropriate international dialing code.
\nIf you’ve registered a custom sender ID on Relay360, you can include it in your request body so that recipients receive the SMS using your approved sender identity.
\nThis endpoint allows you to instantly send a WhatsApp message to one or more phone numbers, or to a phonebook you've created on your Relay360 dashboard. All phone numbers must be in full international format.
\nWhatsApp requires all outbound messages to use an approved template. Once you've created and registered a template on Relay360 and it has been approved, you may reference it in your request using the template parameter.
1. Template Variables
\n{{1}}, {{2}}, etc.)variables parameter to supply values in the correct order2. Header Media Support You can attach media to your WhatsApp template header:
\nimage_url parameter (JPG, PNG, GIF)video_url parameter (MP4, 3GPP)document_url parameter (PDF, DOC, etc.)Important Notes:
\nvideo_url > document_url > image_urlPOST https://api.relay360.dev/v1/dispatch/whatsapp\n\n*Either msisdns OR phonebook_id is required
Example 1: Template with Variables + Image Header
\nTemplate Name: product_announcement\nCategory: MARKETING\nHeader Type: Image\nMessage Body: Hello {{1}}! Check out our new {{2}} for only {{3}}. Limited time offer!\n\nExample 2: Template with Variables + Video Header
\nTemplate Name: tutorial_video\nCategory: UTILITY\nHeader Type: Video\nMessage Body: Hi {{1}}, here's the tutorial you requested for {{2}}.\n\nExample 3: Template with Variables + Document Header
\nTemplate Name: invoice_delivery\nCategory: UTILITY\nHeader Type: Document\nMessage Body: Dear {{1}}, your invoice #{{2}} for {{3}} is attached above.\n\nExample 4: Template with Variables Only (No Header)
\nTemplate Name: welcome_message\nCategory: MARKETING\nHeader Type: None\nMessage Body: Hello {{1}}! Welcome to {{2}}. Your subscription expires on {{3}}.\n\nRequest:
\nPOST https://api.relay360.dev/v1/dispatch/whatsapp\nAuthorization: Bearer YOUR_API_KEY\nContent-Type: application/json\n{\n \"name\": \"Product Launch Campaign\",\n \"msisdns\": \"+2348012345678,+2348087654321\",\n \"template\": \"product_announcement\",\n \"variables\": [\"John Doe\", \"Smart Phone X\", \"₦150,000\"],\n \"image_url\": \"https://example.com/images/smartphone.jpg\"\n}\n\nResponse:
\n{\n \"status\": true,\n \"message\": \"WhatsApp broadcast sent\",\n \"data\": {\n \"id\": 12345,\n \"name\": \"Product Launch Campaign\",\n \"client_id\": 100,\n \"type\": \"whatsapp\",\n \"status\": \"success\",\n \"created_at\": \"2025-12-13T10:30:00Z\"\n }\n}\n\nRequest:
\n{\n \"name\": \"Tutorial Distribution\",\n \"phonebook_id\": \"567\",\n \"template\": \"tutorial_video\",\n \"variables\": [\"Sarah\", \"Advanced Features\"],\n \"video_url\": \"https://example.com/videos/tutorial.mp4\"\n}\n\nRequest:
\n{\n \"name\": \"Invoice Delivery\",\n \"msisdns\": \"+2348012345678\",\n \"template\": \"invoice_delivery\",\n \"variables\": [\"John Smith\", \"INV-2025-001\", \"December 2025\"],\n \"document_url\": \"https://example.com/invoices/INV-2025-001.pdf\"\n}\n\nRequest:
\n{\n \"name\": \"Welcome Campaign\",\n \"msisdns\": \"+2348012345678,+2348087654321\",\n \"template\": \"welcome_message\",\n \"variables\": [\"John Doe\", \"Premium Service\", \"December 31, 2025\"]\n}\n\nRequest:
\n{\n \"name\": \"Reminder Campaign\",\n \"phonebook_id\": \"789\",\n \"template\": \"appointment_reminder\",\n \"variables\": [\"Sarah\", \"December 15, 2025\", \"2:00 PM\"],\n \"run_time\": \"2025-12-14T08:00:00Z\"\n}\n\nVariables are replaced in sequential order:
\n{{1}}{{2}}{{3}}Example:
\n{\n \"template\": \"order_update\",\n \"variables\": [\"John\", \"ORD123\", \"Shipped\", \"Dec 15\"]\n}\n\nFor template: \"Hello {{1}}, order {{2}} is {{3}}. Expected delivery: {{4}}\"
Result: \"Hello John, order ORD123 is Shipped. Expected delivery: Dec 15\"
If you provide multiple header URLs, the service will use them in this priority order:
\nExample:
\n{\n \"template\": \"product_promo\",\n \"image_url\": \"https://example.com/image.jpg\",\n \"video_url\": \"https://example.com/video.mp4\"\n}\n\nResult: Only the video will be used (video_url takes priority)
\n{\n \"status\": false,\n \"error\": \"Template invalid or unapproved\"\n}\n\n{\n \"status\": false,\n \"error\": \"Insufficient balance. Please load some airtime credit.\"\n}\n\n{\n \"status\": false,\n \"error\": \"Template requires 3 variables but 2 were provided\"\n}\n\n{\n \"status\": false,\n \"error\": {\n \"image_url\": [\"The image url format is invalid.\"]\n }\n}\n\nHello! Check out our latest January offers.
\"\n}"},"url":"{{BASE_URL}}/dispatch/email","description":"This endpoint allows you to send emails to one or more recipients using Relay360. Before sending emails, ensure you have added and verified a sending domain on your Relay360 dashboard. Verified senders guarantee deliverability and compliance with email standards.
\nmessage_text or message_html should be included.emails must be a comma-separated string (e.g. \"john@example.com,jane@example.com\").run_time is omitted, the email is dispatched immediately.Hello! Check out our latest January offers.
\"\n}"},"url":"{{BASE_URL}}/dispatch/email"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.32"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sat, 29 Nov 2025 00:39:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization, X-Requested-With"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Email broadcast sent successfully\",\n \"data\": {\n \"name\": \"Promo Email - November\",\n \"client_id\": 38,\n \"emails\": \"josholatunde@gmail.com\",\n \"from_email\": \"noreply@lafira.pro\",\n \"from_name\": \"Lafira\",\n \"subject\": \"Welcome to our January Promo!\",\n \"message_text\": \"Hello! Check out our latest January offers.\",\n \"message_html\": \"Hello! Check out our latest January offers.
\",\n \"status\": \"completed\",\n \"total_recipients\": 1,\n \"run_time\": \"2025-11-29T00:39:22.000000Z\",\n \"updated_at\": \"2025-11-29T00:39:24.000000Z\",\n \"created_at\": \"2025-11-29T00:39:22.000000Z\",\n \"id\": 17,\n \"sent_count\": 1\n }\n}"},{"id":"edd9a3af-b294-4094-81ee-06fe64306f2b","name":"Create Email Dispatch Job - Schedule","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Promo Email - November\",\n \"emails\": \"josholatunde@gmail.com\",\n \"from_email\": \"noreply@lafira.pro\",\n \"from_name\": \"Lafira\",\n \"subject\": \"Welcome to our January Promo!\",\n \"message_text\": \"Hello! Check out our latest January offers.\",\n \"message_html\": \"Hello! Check out our latest January offers.
\",\n \"run_time\": \"2025-11-29 01:55:00\"\n}"},"url":"{{BASE_URL}}/dispatch/email"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.32"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sat, 29 Nov 2025 00:48:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization, X-Requested-With"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Email broadcast scheduled successfully\",\n \"data\": {\n \"name\": \"Promo Email - November\",\n \"client_id\": 38,\n \"emails\": \"josholatunde@gmail.com\",\n \"from_email\": \"noreply@lafira.pro\",\n \"from_name\": \"Lafira\",\n \"subject\": \"Welcome to our January Promo!\",\n \"message_text\": \"Hello! Check out our latest January offers.\",\n \"message_html\": \"Hello! Check out our latest January offers.
\",\n \"status\": \"completed\",\n \"total_recipients\": 1,\n \"run_time\": \"2025-11-29T00:55:00.000000Z\",\n \"updated_at\": \"2025-11-29T00:48:39.000000Z\",\n \"created_at\": \"2025-11-29T00:48:37.000000Z\",\n \"id\": 21,\n \"sent_count\": 1\n }\n}"}],"_postman_id":"dde15a74-f136-459b-8d84-089e22ee8068"},{"name":"Create Voice Dispatch Job","id":"8f2e53e7-ca05-468c-b919-0229f5b11e38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"msisdns\": \"+2348124163122\",\n\"name\": \"test\",\n\"message_text\": \"Hello to you too\",\n\"external_id\": \"91b49feb-4642-5b6b-911f-4c874e202d8b\",\n\"webhook_url\": \"https://webhook.site/a27c8be1-2b90-48cc-b28e-8e4da0b2b288\"\n}"},"url":"{{BASE_URL}}/dispatch/voice","description":"This endpoint allows you to instantly send or schedule an outbound voice message to one or more phone numbers, or to a phonebook you’ve created on your Relay360 dashboard. All phone numbers must include the full international dialing code.
\nIf you have one or more verified outbound phone numbers on Relay360, you may specify one using the phone_number parameter so recipients see that number as the caller ID.
Voice messages can be delivered in two ways:
\nBy uploading an audio file (wav or mp3)
By sending text, which Relay360 will automatically convert to audio
\nThis endpoint allows you to retrieve key analytics for a specific dispatch job.
You must provide the id returned when the job was initially created or scheduled.
You can also obtain this id by calling the Get All Dispatch Jobs endpoint.
totalProcessed — Total number of recipients associated with the dispatch job.
\nsuccess — Number of messages delivered successfully, or number of calls placed successfully (for voice dispatch jobs).
\npending — Number of messages not yet delivered, or calls not yet attempted or completed (for voice dispatch jobs).
\nsuccessRatePercentage — Percentage of successful deliveries, or call pickup rate (for voice dispatch jobs).
\nThe Message Dispatch APIs allow you to send SMS, Voice, Email, or WhatsApp messages to one or multiple recipients. They also provide endpoints for checking the delivery status of any message across supported channels, giving you full visibility into each communication attempt.
\n","_postman_id":"8a7ef7af-5235-4ca3-9c0f-3d1a3c89fa16"},{"name":"Verification","item":[{"name":"Initiate SMS Verification Code","id":"9fefcf17-7781-4ded-a0ad-5be3dc6be8f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"msisdn\": \"+2348124163122\",\n\"otp\": \"1012JK\"\n}"},"url":"{{BASE_URL}}/verification/sms","description":"This endpoint allows you to send a one-time verification code via SMS to a phone number.
\nNote: If no otp is provided, Relay360 automatically generates one.
This endpoint allows you to send a one-time verification code via WhatsApp to a registered phone number.
\nNote: If no otp is provided, Relay360 automatically generates one.
This endpoint allows you to send a one-time verification code via email. Before sending an email verification code, ensure you have added and verified a sending domain on your Relay360 dashboard. Verified senders guarantee deliverability and compliance with email standards.
\nNote: If no otp is provided, Relay360 automatically generates one.
This endpoint allows you to send a one-time verification code as a voice call to a phone number.
\nNote: If no otp is provided, Relay360 automatically generates one.
After sending a one-time verification code via SMS or Voice, you can use this endpoint to validate the code provided by the user.
\nNotes:
\nThis endpoint supports verification for codes sent via SMS, WhatsApp, Email or Voice channels.
\nFor codes sent via SMS, WhatsApp or Voice channels you must supply the msisdn parameter. For codes sent via the Email channel, you must supply the email parameter
A successful response confirms the OTP is valid and within its expiration period.
\nThe Verification APIs allow you to add secure user verification to your web or mobile applications. You can deliver one-time codes via SMS, WhatsApp, Email or Voice calls, and verify them programmatically.
\nThese APIs are ideal for:
\nUser authentication
\nTransaction verification
\nMulti-factor authentication
\nAny scenario requiring temporary, secure access codes
\nReturns a list of phone numbers associated with your Relay360 account. You can request a phone number from your Relay360 dashboard.
\nUsage:
Use the phone_number value when dispatching a voice message or verification code. The phone number will appear as the caller ID.
Returns a list of your saved phonebooks. You can create a phonebook from your Relay360 dashboard.
\nUsage:
Use the id value as the recipient source when dispatching SMS, Voice, or WhatsApp messages.
This serves as an alternative to manually supplying a list of phone numbers.
Returns the SMS sender IDs that are approved and available on your Relay360 account.
\nUsage:
Use the sender_id value when dispatching SMS messages.
Required for standard SMS broadcasts
\nOptional for verification/OTP SMS
\nReturns a list of your approved WhatsApp templates. You can create a whatsapp template from your Relay360 dashboard.
\nUsage:
Use the value of the template prop in each template object as the template parameter when dispatching WhatsApp messages.
Returns a list of your verified email domains. You can create a whatsapp template from your Relay360 dashboard.
\nUsage:
Use the value of the template prop in each template object as the template parameter when dispatching WhatsApp messages.
Get basic info about your account
\n","urlObject":{"path":["clients","resources","summary"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"dc0137dc-7129-4b02-a066-2da4c5bca0ab","name":"Get Account Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/clients/resources/summary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.32"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 10 Dec 2025 22:00:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization, X-Requested-With"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"airtime_balance\": 6021.5,\n \"name\": \"Escobar\",\n \"client_id\": 38,\n \"email\": \"femiinstructor@2200freefonts.com\",\n \"phone_number\": \"+2349876543234\",\n \"contact_person\": \"Em Jay\",\n \"date_joined\": \"21 Nov 2025\"\n },\n \"status\": true\n}"}],"_postman_id":"036257a6-0a79-46a0-b254-6e4fd05a687c"}],"id":"bfa5305a-6b92-4ccf-98f6-552942e2f220","description":"The Resources section provides all account-specific assets needed for messaging: approved sender IDs, available phone numbers, and saved phonebooks.
Your application references these values when dispatching SMS, Voice, WhatsApp, or Email messages.
It also provides an endpoint that returns basic info about your account.
\n","_postman_id":"bfa5305a-6b92-4ccf-98f6-552942e2f220"},{"name":"Webhooks","item":[{"name":"SMS Dispatch Webhook","id":"85ea821c-429c-48ba-9b6c-1575ff8aef13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"webhook_url","description":"When you create an SMS Dispatch Job and specify a webhook_url in your request, Relay360 will send webhook notifications to that URL for important delivery events.
These events help you track real-time delivery behavior for every SMS recipient in a dispatch job.
\nA webhook request is sent whenever the delivery status of a message changes.
\nStatuses may include:sent, submitted, buffered, success, failed, rejected, absentsubscriber, expired.
(See the SMS Status Reference section for detailed meanings.)
\nPOST {webhook_url}\nContent-Type: application/json\n\n{\n \"event\": \"dispatch.sms\",\n \"data\": {\n \"id\": 93722,\n \"job_id\": 4410,\n \"client_id\": 110,\n \"msisdn\": \"+2348000000000\",\n \"message_text\": \"Hello, thanks for using Relay360!\",\n \"run_time\": \"2025-01-18T12:45:22Z\",\n \"created_at\": \"2025-01-18T12:45:22Z\",\n \"updated_at\": \"2025-01-18T12:46:03Z\",\n \"status\": \"success\",\n \"status_text\": null,\n \"cost\": 4.5,\n \"external_id\": \"78922de8-1c4c-44bc-ba92-3bcdbd4c12c1\"\n }\n}\n\nWhen you initiate an SMS Verification Request and include a webhook_url, Relay360 sends webhook events for delivery updates.
These events indicate whether the OTP SMS was successfully delivered to the end user.
\nA webhook request is sent only when a delivery outcome occurs, such as:
\nsuccess, failed, rejected, absentsubscriber, expired.
POST {webhook_url}\nContent-Type: application/json\n\n{\n \"event\": \"verification.sms\",\n \"data\": {\n \"id\": 118822,\n \"client_id\": 110,\n \"msisdn\": \"+2348000000000\",\n \"expires_at\": \"2025-01-18T12:59:00Z\",\n \"created_at\": \"2025-01-18T12:49:00Z\",\n \"updated_at\": \"2025-01-18T12:49:45Z\",\n \"deliverystatus\": \"success\",\n \"status\": \"verified\",\n \"status_text\": null,\n \"generated_by\": \"Provider\"\n }\n}\n\nUse this reference to interpret webhook delivery results; the deliverystatus prop in the sms dispatch and sms verification webhook payloads.
When you create a Voice Dispatch Job and include the webhook_url parameter, Relay360 will send a webhook event for each call that is successfully placed.
POST webhook_url\nContent-Type: application/json\n\n{\n \"event\": \"dispatch.voice\",\n \"data\": {\n \"id\": 57208,\n \"name\": \"test\",\n \"client_id\": 111,\n \"job_id\": 4584,\n \"message_audio\": null,\n \"message_text\": \"Hello to you too\",\n \"msisdn\": \"+2348000000000\",\n \"run_time\": \"2022-12-01 02:29:33\",\n \"created_at\": \"2022-12-01 02:29:34\",\n \"updated_at\": \"2022-12-01 02:29:46\",\n \"duration_in_seconds\": 4,\n \"cost\": 22,\n \"type\": \"voice\",\n \"external_id\": \"91b49feb-4642-5b6b-911f-4c874e202d8b\",\n \"deliverystatus\": \"success\"\n }\n}\n\ndeliverystatus = \"success\" means the call was successfully placed.
The actual time spent on the call is returned in duration_in_seconds.
Only successfully placed calls are billable.
\nRelay360 sends WhatsApp delivery events to your webhook URL whenever you initiate a WhatsApp dispatch job and specify the webhook_url parameter.
These events allow you to track message progress across all supported WhatsApp statuses.
Relay360 posts a webhook event each time the message status changes, ensuring you always have the latest delivery state.
\nRelay360 will send a webhook request when the message transitions into any of the following states:
\nWhenever a WhatsApp message changes state, Relay360 sends a POST request to your webhook_url.
POST webhook_url\nContent-Type: application/json\n\n{\n{\n \"event\": \"dispatch.whatsapp\",\n \"data\": {\n \"id\": 12348,\n \"client_id\": 789,\n \"job_id\": 459,\n \"type\": \"whatsapp\",\n \"msisdn\": \"2348012345678\",\n \"message_text\": null,\n \"run_time\": \"2025-12-07 14:30:00\",\n \"created_at\": \"2025-12-07 14:25:00\",\n \"updated_at\": \"2025-12-07 14:30:45\",\n \"cost\": 0,\n \"external_id\": \"ext_101jkl\",\n \"deliverystatus\": \"failed\",\n \"status_text\": \"Invalid phone number; Message expired\",\n \"delivered_at\": null\n }\n}\n\nWhen you initiate a Voice Verification request and include a webhook_url, Relay360 will send a webhook event only when the call is successfully placed.
POST webhook_url\nContent-Type: application/json\n\n{\n \"event\": \"verification.voice\",\n \"data\": {\n \"id\": 57208,\n \"client_id\": 111,\n \"msisdn\": \"+2348000000000\",\n \"type\": \"voice\",\n \"expires_at\": \"2022-12-01 02:39:34\",\n \"created_at\": \"2022-12-01 02:29:34\",\n \"updated_at\": \"2022-12-01 02:29:46\",\n \"message\": null,\n \"duration_in_seconds\": 4,\n \"ussd_suffix_code\": null,\n \"generated_by\": \"Client\",\n \"deliverystatus\": \"success\"\n }\n}\n\ndeliverystatus = \"success\" indicates the call was placed successfully.
The call duration is provided in duration_in_seconds.
Only successful verification calls incur charges.
\nWhen you initiate a WhatsApp Verification request and include a webhook_url, Relay360 will send a webhook event only when the message status changes, ensuring you always have the latest delivery state.
POST webhook_url\nContent-Type: application/json\n\n{\n \"event\": \"verification.whatsapp\",\n \"data\": {\n \"id\": 54323,\n \"client_id\": 789,\n \"msisdn\": \"2348012345678\",\n \"type\": \"whatsapp\",\n \"expires_at\": \"2025-12-07 14:40:00\",\n \"created_at\": \"2025-12-07 14:30:00\",\n \"updated_at\": \"2025-12-07 14:30:18\",\n \"generated_by\": \"Provider\",\n \"deliverystatus\": \"read\"\n }\n}\n\nRelay360 will send a webhook request when the message transitions into any of the following states:
\n","urlObject":{"host":["webhook_url"],"query":[],"variable":[]}},"response":[],"_postman_id":"4febe78e-86b4-436f-8cb7-ccc840a18c13"}],"id":"eee447f2-de56-4848-a190-959f511fd209","description":"Relay360 provides a webhook mechanism that allows your application to receive real-time delivery reports for your dispatch and verification jobs.
When creating a dispatch job or when initiating a verification request using Voice, SMS, WhatsApp, or Email, you may optionally specify a webhook_urlprop.
If provided, Relay360 will send webhook events to this URL whenever important lifecycle events occur (such as successful call placements or verification results).
\n","_postman_id":"eee447f2-de56-4848-a190-959f511fd209"}]}