{"info":{"_postman_id":"c8a114f7-517f-412a-ab0b-0b0348ca8a09","name":"V2NMobile SMS API","description":"

The v2nmobile SMS API enables the consumer to push real time sms notification to any mobile number of their choice. The consumer is expected to visit https://v2nmobile.com, create an account, verify the account and then use the credentials of the created account as authentication parameters for this API.

Authentication

This API uses Basic Authentication.

Response status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
401	Invalid credentials.
412	Insufficient wallet balance.
200	A successful request.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"686218","collectionId":"c8a114f7-517f-412a-ab0b-0b0348ca8a09","publishedId":"2s9Ykoe2NA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-19T17:46:50.000Z"},"item":[{"name":"Get Account Details","event":[{"listen":"test","script":{"id":"4616e76b-d340-44ad-899e-81462278460b","exec":[""],"type":"text/javascript"}}],"id":"fe49e1db-e4d0-4216-bce0-19cf56112c1f","request":{"method":"GET","header":[],"url":"https://v2nmobile.com/api/info","description":"

This returns the account information of the consumer. The information includes the account balance, pricing amidst other things.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"abcde"},{"key":"password","value":"asdsd"}]},"isInherited":true,"source":{"_postman_id":"c8a114f7-517f-412a-ab0b-0b0348ca8a09","id":"c8a114f7-517f-412a-ab0b-0b0348ca8a09","name":"V2NMobile SMS API","type":"collection"}},"urlObject":{"host":["https://v2nmobile.com/api/info"],"query":[],"variable":[]}},"response":[{"id":"0820bab6-54ed-4d1e-b7e5-60d1d3b1d7d0","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://v2nmobile.com/api/info","host":["https://v2nmobile.com/api/info"],"query":[{"key":"access_key","value":"{{accessKey}}","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Dec 2023 18:32:41 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"370"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"info\": {\n \"profile\": {\n \"id\": \"gabrieloyetunde@gmail.com\",\n \"phoneNumber\": \"08132586075\",\n \"companyName\": \"Gabriel Inc\",\n \"companyAddress\": \"Berger Str. 40\",\n \"category\": \"User\",\n \"status\": \"Active\",\n \"profileDate\": \"2023-10-12 17:34:03\",\n \"balance\": \"5000\"\n },\n \"price\": {\n \"mtn\": \"6\",\n \"glo\": \"3\",\n \"airtel\": \"4.2\",\n \"9mobile\": \"4\",\n \"international\": \"20\"\n }\n },\n \"description\": \"request has been processed\"\n}"},{"id":"f418a692-d75c-4fa4-9a91-060659c6a549","name":"Failed Authentication","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://v2nmobile.com/api/info","host":["https://v2nmobile.com/api/info"],"query":[{"key":"access_key","value":"{{accessKey}}","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"Authorization Required","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Dec 2023 18:34:22 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"message\": \"invalid api credentials\",\n \"description\": \"access denied\"\n}"}],"_postman_id":"fe49e1db-e4d0-4216-bce0-19cf56112c1f"},{"name":"Push SMS","event":[{"listen":"test","script":{"id":"06a59b76-44e8-4e66-9f9c-310e6fc2fdd0","exec":[""],"type":"text/javascript","packages":{}}}],"id":"28c3aa46-492b-4d34-b75a-75eaf0e51435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sms\": [\n {\n \"id\": \"ef\",\n \"receiver\": \"2348132586076\",\n \"sender\": \"ABC\",\n \"message\": \"good afternoon\",\n \"type\": \"sms\"\n },\n {\n \"id\": \"gh\",\n \"receiver\": \"09051588853\",\n \"sender\": \"DEF\",\n \"message\": \"good afternoon\",\n \"type\": \"flash\"\n }\n ]\n}"},"url":"https://v2nmobile.com/api/push","description":"

The sms parameter of the request payload is expected to be a list of object. Each object should have the below properties

id — A unique alphanumeric identifier for the sms object.
\n
receiver — The phone number of the intended recipient of the sms.
\n
sender — The consumer's sender ID.
\n
message — The content of the message meant to be forwarded to the receiver's phone number.
\n
type — The type of the message. The value can be either flash or sms.
\n

The parameters in the response payload are

status — This indicates the status of the request. A value of 200 means the request was well sent.
\n
total — This indicates the total number of items in the sms parameter in the request payload.
\n
accepted — The number of sms items that were succesfully processed and forwarded to VAS2Nets SMS gateway.
\n
rejected — The number os sms items that did not get forwarded to VAS2Nets SMS gateway. An sms can be rejected if the one or more property is missing in the object or the the id ia flagged as duplicate id.
\n
description — A short description of the status parameter.
\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"abcde"},{"key":"password","value":"asdsd"}]},"isInherited":true,"source":{"_postman_id":"c8a114f7-517f-412a-ab0b-0b0348ca8a09","id":"c8a114f7-517f-412a-ab0b-0b0348ca8a09","name":"V2NMobile SMS API","type":"collection"}},"urlObject":{"host":["https://v2nmobile.com/api/push"],"query":[],"variable":[]}},"response":[{"id":"b69a5ba1-4916-42d9-85aa-722fea8b0fee","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sms\": [\n {\n \"id\": 1, \n \"receiver\": \"2348132586075\", \n \"sender\": \"ABC\", \n \"message\": \"good afternoon\", \n \"type\" : \"sms\"\n },\n {\n \"id\": 50, \n \"receiver\": \"09051588853\", \n \"sender\": \"DEF\", \n \"message\": \"good afternoon\", \n \"type\" : \"flash\"\n }\n ]\n}"},"url":"https://v2nmobile.com/api/push"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Dec 2023 18:58:42 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"total\": 2,\n \"accepted\": 1,\n \"description\": \"request has been processed\"\n}"},{"id":"28565847-3966-4210-b2ca-4df289bfc0e0","name":"Wrong Request Payload Format","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"collection\": {\n \"info\": {\n \"name\": \"{{collectionName}}\",\n \"schema\": \"{{collectionSchemaUrl}}\"\n },\n \"item\": [\n {\n \"request\": {}\n }\n ]\n }\n}"},"url":"https://v2nmobile.com/api/push"},"status":"Authorization Required","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Dec 2023 18:55:52 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incomplete Body Parameters\",\n \"extra\": \"sms is missing\",\n \"status\": 401,\n \"description\": \"access denied\"\n}"},{"id":"1063960a-4d22-4d24-bc5b-6e0caed920fb","name":"Insufficient Balance","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sms\": [\n {\n \"id\": 1, \n \"receiver\": \"2348132586075\", \n \"sender\": \"ABC\", \n \"message\": \"good afternoon\", \n \"type\" : \"sms\"\n },\n {\n \"id\": 50, \n \"receiver\": \"09051588853\", \n \"sender\": \"DEF\", \n \"message\": \"good afternoon\", \n \"type\" : \"flash\"\n }\n ]\n}"},"url":"https://v2nmobile.com/api/push"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Dec 2023 19:15:03 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"90"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 412,\n \"message\": \"insufficient wallet balance\",\n \"description\": \"precondition failed\"\n}"}],"_postman_id":"28c3aa46-492b-4d34-b75a-75eaf0e51435"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"abcde"},{"key":"password","value":"asdsd"}]}},"event":[{"listen":"prerequest","script":{"id":"ce1c904c-e959-48b1-9cf5-fc1efd9b3b1b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"47f6dba7-5434-4f59-b905-ea9703fcc2d2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BASE_URL","value":"https://v2nmobile.com/api/"},{"key":"API_USERNAME","value":"abcde"},{"key":"API_PASSWORD","value":"asdsd"}]}