VeloConnect CPaaS API
  1. senders
VeloConnect CPaaS API
  • VeloConnect
    • WhatsApp
      • Whatsapp-campaigns
        • Creates a new campaign
        • Returns campaigns
      • whatsapp-contact-lists
        • {id}
          • Contacts
            • Creates new contacts
            • Returns contacts
          • Whats App Partners Delete Whats App Contact List
        • Creates a new contact list
        • Returns contact lists
      • whatsapp-contacts
        • Updates contacts
        • Deletes contacts with specified Ids
      • whatsapp-templates
        • {id}
          • Deletes template
        • Creates new template
        • Returns templates
      • whatsapp-messages
        • Sends a message
      • whatsapp-conversations
        • {id}
          • messages
            • Returns conversation messages
        • Returns conversations
      • senders
        • Returns sender ids
          GET
    • GetSenderIDList
      • Get senderId's list.
      • Get senderId's list.
    • SenderIDStatus
      • SenderId status.
      • SenderId status.
    • AddContact
      • Add contact to contact list.
      • Add contact to contact list.
    • DeleteContact
      • Delete contact to contact list.
      • Delete contact to contact list.
    • SendSMS
      • Send SMS.
      • Send SMS.
    • SendSMSMulti
      • Send SMS multi.
      • Send SMS multi.
    • Verify
      • Send verification SMS.
      • Send verification SMS.
    • VerifyStatus
      • Verify OTP code.
      • Verify OTP code.
    • Viber Business Messaging
      • OTP
        • OTP Templates
          • Get OTP Templates
        • OTP Message
          • Send OTP
      • Viber Templates
        • Create template
        • Delete Template
        • Get Template
        • List templates
      • Campaign
        • New Campaign
        • Returns Campaigns
      • Contact Lists
        • New contact list
        • Returns contact lists
        • Deletes contact list with specified ID
        • New contact
        • Updates contacts
        • Delete contacts with specified IDs
        • Returns contacts
      • Conversations
        • Returns viber inbox conversations
        • Returns viber conversations messages
        • Sends a Viber message
      • Records
        • Returns the list of viber message data records
        • Returns viber message data record by ID
      • Summaries
        • Return messages summaries
      • Senders
        • Viber Senders
        • Viber Sender by id
    • Cascading
      • New cascading campaign
    • Account
      • CheckBalance
        • Check balance.
        • Check balance.
      • Rat Plans
        • Get Rate plans
      • Get whitelisted IPs
      • Add whitelisted IP
  • VeloPBX
    • Get CDR
      GET
  1. senders

Returns sender ids

GET
/api/partners/senders

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Responses

🟢200
application/json
Body

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'api.velosms.com/api/partners/senders?PageNumber=&PageSize=' \
--header 'apiId: <string>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sender ids
{
  "data": [
    {
      "items": [
        {
          "id": "<long>",
          "country": "<string>",
          "title": "<string>",
          "notes": "<string>",
          "userId": "<long>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userStatus": "<string>",
          "status": "Deactivated",
          "providerType": "Whatsapp",
          "senderIdTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "trafficTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "senderIdMediaAttachments": [
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "mccMncs": [
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            },
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            }
          ],
          "createdAt": "<dateTime>",
          "approvedAt": "<dateTime>"
        },
        {
          "id": "<long>",
          "country": "<string>",
          "title": "<string>",
          "notes": "<string>",
          "userId": "<long>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userStatus": "<string>",
          "status": "Pending",
          "providerType": "Email",
          "senderIdTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "trafficTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "senderIdMediaAttachments": [
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "mccMncs": [
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            },
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            }
          ],
          "createdAt": "<dateTime>",
          "approvedAt": "<dateTime>"
        }
      ],
      "totalCount": "<long>",
      "pageSize": "<integer>",
      "pageNumber": "<integer>"
    },
    {
      "items": [
        {
          "id": "<long>",
          "country": "<string>",
          "title": "<string>",
          "notes": "<string>",
          "userId": "<long>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userStatus": "<string>",
          "status": "Declined",
          "providerType": "SMS",
          "senderIdTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "trafficTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "senderIdMediaAttachments": [
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "mccMncs": [
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            },
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            }
          ],
          "createdAt": "<dateTime>",
          "approvedAt": "<dateTime>"
        },
        {
          "id": "<long>",
          "country": "<string>",
          "title": "<string>",
          "notes": "<string>",
          "userId": "<long>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userStatus": "<string>",
          "status": "Active",
          "providerType": "TwoWaySms",
          "senderIdTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "trafficTypes": [
            {
              "id": "<long>",
              "name": "<string>"
            },
            {
              "id": "<long>",
              "name": "<string>"
            }
          ],
          "senderIdMediaAttachments": [
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "attachmentType": "<string>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "mccMncs": [
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            },
            {
              "id": "<long>",
              "areaId": "<long>",
              "code": "<string>",
              "mccMnc": "<string>",
              "mobileOperatorName": "<string>",
              "mobileOperatorCountry": "<string>",
              "providerType": "<string>",
              "currency": "<string>",
              "localSetupFee": "<number>",
              "localMonthlyFee": "<number>",
              "setupFee": "<number>",
              "monthlyFee": "<number>",
              "isLetterAuthorization": "<boolean>",
              "isRegistrationForm": "<boolean>",
              "isCompanyCertificate": "<boolean>"
            }
          ],
          "createdAt": "<dateTime>",
          "approvedAt": "<dateTime>"
        }
      ],
      "totalCount": "<long>",
      "pageSize": "<integer>",
      "pageNumber": "<integer>"
    }
  ]
}
Modified at 2025-12-05 09:59:43
Previous
Returns conversations
Next
Get senderId's list.
Built with