Send Messages

POST

/api/v2/message/send

POST

/api/v2/message/send

curl -X POST https://api.beconversive.com/api/v2/message/send \
     -H "apiKey: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "userPayload": {
    "type": "api",
    "apiKey": "YOUR_API_KEY"
  },
  "messageDetails": [
    {
      "recipient": [
        {
          "channelType": "sms",
          "phone": "756384933"
        }
      ],
      "source": 8001,
      "messageId": "sms-001",
      "message": {
        "type": "text",
        "content": {
          "messageText": "Text message"
        }
      }
    },
    {
      "recipient": [
        {
          "channelType": "sms",
          "phone": "756384934"
        }
      ],
      "source": 8001,
      "messageId": "sms-002",
      "message": {
        "type": "text",
        "content": {
          "messageText": "Text message"
        }
      }
    }
  ]
}'

{
  "response": {
    "vstatus": "string",
    "responseText": "string"
  }
}

Authentication

apiKeystring

API Key authentication via header

Request

This endpoint expects an object.

userPayloadobjectRequired

messageDetailslist of objectsRequired

Response

Messages queued

responseobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error