# VeloConnect API ## API Docs - Programmatic API (API Key) > Account & Pricing [Check balance (GET form)](https://docs.veloconnect.me/36987835e0.md): Returns the current balance of your account and the currency it is kept in. Use it before a large send, or to warn yourself when the balance runs low. - Programmatic API (API Key) > Account & Pricing [Check balance](https://docs.veloconnect.me/36987836e0.md): Returns the current balance of your account and the currency it is kept in. Use it before a large send, or to warn yourself when the balance runs low. - Programmatic API (API Key) > Account & Pricing [List rate plans](https://docs.veloconnect.me/36987837e0.md): Lists the SMS price plans of your account. Use it to find the id of a plan when you want to choose the plan yourself in a send call, with `rate_plan_id` in place of `sms_type`. - Programmatic API (API Key) > Sender IDs [List sender names (GET form)](https://docs.veloconnect.me/36987838e0.md): Lists the sender names of your account, each with its country. Use it to check how a name is written before you put it in `sender_id` of a send call. - Programmatic API (API Key) > Sender IDs [List sender names](https://docs.veloconnect.me/36987839e0.md): Lists the sender names of your account, each with its country. Use it to check how a name is written before you put it in `sender_id` of a send call. - Programmatic API (API Key) > Sender IDs [Get sender name status (GET form)](https://docs.veloconnect.me/36987840e0.md): Returns the approval state of one sender name of your account. Use it after you ask for a new sender name, to learn when you can send with it. - Programmatic API (API Key) > Sender IDs [Get sender name status](https://docs.veloconnect.me/36987841e0.md): Returns the approval state of one sender name of your account. Use it after you ask for a new sender name, to learn when you can send with it. - Programmatic API (API Key) > OTP Verification [Send a verification code (GET form)](https://docs.veloconnect.me/36987846e0.md): Sends a one-time code by SMS to a phone number. Use it to confirm that a person owns the number: we make a 4-digit code and send it, and you check what the person types with the check call (`POST /api/VerifyStatus`). - Programmatic API (API Key) > OTP Verification [Send a verification code](https://docs.veloconnect.me/36987847e0.md): Sends a one-time code by SMS to a phone number. Use it to confirm that a person owns the number: we make a 4-digit code and send it, and you check what the person types with the check call (`POST /api/VerifyStatus`). - Programmatic API (API Key) > OTP Verification [Check a verification code (GET form)](https://docs.veloconnect.me/36987848e0.md): Checks a code that a person typed against the code we sent with the send call (`POST /api/Verify`). Use it as the second step of a phone number check. - Programmatic API (API Key) > OTP Verification [Check a verification code](https://docs.veloconnect.me/36987849e0.md): Checks a code that a person typed against the code we sent with the send call (`POST /api/Verify`). Use it as the second step of a phone number check. - Programmatic API (API Key) > SMS Status [List SMS records](https://docs.veloconnect.me/36987850e0.md): Lists the SMS records of your account: one record for each SMS sent, with its delivery result and price. Use it to learn what happened to a send, for example to all messages of one `message_id`. - Programmatic API (API Key) > SMS Status [Get an SMS record](https://docs.veloconnect.me/36987851e0.md): Returns one SMS record of your account by its id. Use it to read the delivery result of a single message again. - Programmatic API (API Key) > WhatsApp > senders [List WhatsApp senders](https://docs.veloconnect.me/36987852e0.md): Returns the WhatsApp senders of your account, newest first. Use it to get the numeric `id` of a sender: you pass it as `senderId` when you send a campaign. - Programmatic API (API Key) > WhatsApp > Whatsapp-campaigns [Send a WhatsApp campaign](https://docs.veloconnect.me/36987853e0.md): Sends one approved WhatsApp template to many people. You name the campaign, choose the template and the sender, and give the recipients as contact lists, as contacts in the request, or both. - Programmatic API (API Key) > WhatsApp > Whatsapp-campaigns [List WhatsApp campaigns](https://docs.veloconnect.me/36987854e0.md): Returns the WhatsApp campaigns of your account, newest first. Use it after you send a campaign to follow its status and to read how many messages were sent. - Programmatic API (API Key) > WhatsApp > whatsapp-contact-lists > {id} > Contacts [Add WhatsApp contacts](https://docs.veloconnect.me/36987858e0.md): Adds one or more contacts to a WhatsApp contact list. Send a JSON list, also for one contact. - Programmatic API (API Key) > WhatsApp > whatsapp-contact-lists > {id} > Contacts [List WhatsApp contacts](https://docs.veloconnect.me/36987859e0.md): Returns the contacts of one WhatsApp contact list, newest first. - Programmatic API (API Key) > WhatsApp > whatsapp-contact-lists > {id} [Delete a WhatsApp contact list](https://docs.veloconnect.me/36987857e0.md): Deletes a WhatsApp contact list together with all contacts in it. This cannot be undone. - Programmatic API (API Key) > WhatsApp > whatsapp-contact-lists [Create a WhatsApp contact list](https://docs.veloconnect.me/36987855e0.md): Creates an empty WhatsApp contact list. Fill it with the add-contacts call (`POST /api/partners/whatsapp-contact-lists/{id}/contacts`), then send to it by giving its id in `contactListIds` of a campaign. - Programmatic API (API Key) > WhatsApp > whatsapp-contact-lists [List WhatsApp contact lists](https://docs.veloconnect.me/36987856e0.md): Returns the WhatsApp contact lists of your account, newest first. Use it to find the id of a list before you add contacts to it or send a campaign to it. - Programmatic API (API Key) > WhatsApp > whatsapp-contacts [Update WhatsApp contacts](https://docs.veloconnect.me/36987860e0.md): Changes one or more WhatsApp contacts. Send a JSON list, also for one contact. - Programmatic API (API Key) > WhatsApp > whatsapp-contacts [Delete a WhatsApp contact](https://docs.veloconnect.me/36987861e0.md): Deletes one WhatsApp contact from its contact list. This cannot be undone. - Programmatic API (API Key) > WhatsApp > whatsapp-conversations > {id} > messages [List conversation messages](https://docs.veloconnect.me/36987863e0.md): Returns the messages of one WhatsApp conversation, newest first: what the customer wrote and what you answered. - Programmatic API (API Key) > WhatsApp > whatsapp-conversations [List WhatsApp conversations](https://docs.veloconnect.me/36987862e0.md): Returns the WhatsApp conversations of your account, the one with the newest message first. A conversation starts when a customer writes to your WhatsApp number or answers a campaign message. - Programmatic API (API Key) > WhatsApp > whatsapp-templates > {id} [Delete a WhatsApp template](https://docs.veloconnect.me/36987867e0.md): Deletes a WhatsApp template from your account. This cannot be undone, and the campaigns that were created with the template are deleted together with it. - Programmatic API (API Key) > WhatsApp > whatsapp-templates [Create a WhatsApp template](https://docs.veloconnect.me/36987865e0.md): Creates a WhatsApp message template and sends it to WhatsApp for review. You can use the template in a campaign after WhatsApp has approved it. - Programmatic API (API Key) > WhatsApp > whatsapp-templates [List WhatsApp templates](https://docs.veloconnect.me/36987866e0.md): Returns the WhatsApp templates of your account, newest first. Use it to find the id of a template and to see whether WhatsApp has approved it. - Programmatic API (API Key) > Viber Business Messaging > Campaign [Send a Viber campaign](https://docs.veloconnect.me/36987868e0.md): Sends an approved Viber template to a list of phone numbers, now or at a time you choose. Use it for single and bulk template sends; one-time codes have their own call (`POST /api/partners/viber-otp`). - Programmatic API (API Key) > Viber Business Messaging > Campaign [List Viber campaigns](https://docs.veloconnect.me/36987869e0.md): Returns your Viber campaigns, newest first, one page at a time. Use it to follow a campaign after you create it: its status, how many messages were planned and how many Viber accepted. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [Create a Viber contact list](https://docs.veloconnect.me/36987870e0.md): Creates an empty contact list for Viber. Use a list when you send to the same group of numbers more than once. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [List Viber contact lists](https://docs.veloconnect.me/36987871e0.md): Returns your Viber contact lists, newest first, one page at a time. Use it to find the id of a list. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [Delete a Viber contact list](https://docs.veloconnect.me/36987872e0.md): Deletes one of your contact lists together with all contacts in it. This cannot be undone. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [Add contacts to a list](https://docs.veloconnect.me/36987873e0.md): Adds one or more contacts to one of your Viber contact lists. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [Update contacts in a list](https://docs.veloconnect.me/36987874e0.md): Replaces the data of one or more contacts in a Viber contact list. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [Delete a contact from a list](https://docs.veloconnect.me/36987875e0.md): Deletes one contact from your Viber contact lists. This cannot be undone. - Programmatic API (API Key) > Viber Business Messaging > Contact Lists [List contacts in a list](https://docs.veloconnect.me/36987876e0.md): Returns the contacts of one of your Viber contact lists, newest first, one page at a time. - Programmatic API (API Key) > Viber Business Messaging > Conversations [List Viber conversations](https://docs.veloconnect.me/36987877e0.md): Returns your two-way Viber conversations, one row for each chat, the chat with the newest message first. Use it to build an inbox and to find the `chatId` you need to reply. - Programmatic API (API Key) > Viber Business Messaging > Conversations [List messages of a conversation](https://docs.veloconnect.me/36987879e0.md): Returns the messages of one Viber conversation, newest first, one page at a time: the customer's messages and your replies. - Programmatic API (API Key) > Viber Business Messaging > Records [List Viber message records](https://docs.veloconnect.me/36987880e0.md): Returns the records of your Viber messages, newest first: one record for each message sent to one number. Use it to learn what happened to a campaign or to a one-time code. - Programmatic API (API Key) > Viber Business Messaging > Records [Get a Viber message record](https://docs.veloconnect.me/36987881e0.md): Returns one Viber message record with its full detail, including the result code of the send and the reason when it failed. - Programmatic API (API Key) > Viber Business Messaging > Summaries [Get Viber message totals](https://docs.veloconnect.me/36987882e0.md): Returns the totals of your Viber messages for a period: how many were sent, how many Viber accepted, how many failed and what they cost. - Programmatic API (API Key) > Viber Business Messaging > OTP > OTP Message [Send a Viber one-time code](https://docs.veloconnect.me/36987883e0.md): Sends a one-time code to one phone number in Viber, using one of the ready code templates. You create the code and you check it when the user types it in; this call only delivers it. - Programmatic API (API Key) > Viber Business Messaging > OTP > OTP Templates [List Viber code templates](https://docs.veloconnect.me/36987884e0.md): Returns the ready templates for Viber one-time codes. Use it to pick a template and to see which parameters it needs before you call `POST /api/partners/viber-otp`. - Programmatic API (API Key) > Viber Business Messaging > Senders [Get a Viber sender](https://docs.veloconnect.me/36987885e0.md): Returns one of your active Viber senders by its id. Use it to check that a sender id is still valid before you send. - Programmatic API (API Key) > Viber Business Messaging > Senders [List Viber senders](https://docs.veloconnect.me/36987886e0.md): Returns your active Viber senders. Start here: you need the numeric `id` of a sender to create a template, to send a campaign and to send a one-time code. - Programmatic API (API Key) > Viber Business Messaging > Viber Templates [Create a Viber template](https://docs.veloconnect.me/36987887e0.md): Creates a Viber message template for one of your senders. Every campaign sends a template, so create it first and wait until it is approved. - Programmatic API (API Key) > Viber Business Messaging > Viber Templates [List Viber templates](https://docs.veloconnect.me/36987888e0.md): Returns your Viber templates, newest first, one page at a time. Use it to find a template id or to see which templates are approved. - Programmatic API (API Key) > Viber Business Messaging > Viber Templates [Delete a Viber template](https://docs.veloconnect.me/36987889e0.md): Deletes one of your Viber templates. This cannot be undone. - Programmatic API (API Key) > Viber Business Messaging > Viber Templates [Get a Viber template](https://docs.veloconnect.me/36987890e0.md): Returns one of your Viber templates with its text, files, sender and status. Use it after you create a template to see when it is approved. - Programmatic API (API Key) > Send SMS [Send SMS](https://docs.veloconnect.me/44918226e0.md): Sends one SMS to one phone number. - Programmatic API (API Key) > Send SMS [Send SMS (GET form)](https://docs.veloconnect.me/44918227e0.md): Sends one SMS to one phone number. - Programmatic API (API Key) > Send SMS [Send SMS to many numbers](https://docs.veloconnect.me/44918229e0.md): Sends one text to several phone numbers in one call. - Programmatic API (API Key) > Send SMS [Send SMS to many numbers (GET form)](https://docs.veloconnect.me/44918230e0.md): Sends one text to several phone numbers in one call. - Link Shortener > Analytics [Get statistics for several campaigns](https://docs.veloconnect.me/36987891e0.md): Returns the click statistics of several campaigns in one call. A campaign here is the `campaignId` you put on your links when you create or update them. - Link Shortener > Analytics [Get campaign statistics](https://docs.veloconnect.me/36987892e0.md): Returns the click statistics of one campaign: all your links that carry the same `campaignId`. - Link Shortener > Analytics [Get contact statistics](https://docs.veloconnect.me/36987893e0.md): Returns the click statistics of one contact: all your links that carry the same `contactId`. Use it to see whether one person opened the links you sent them. - Link Shortener > Analytics [Get link statistics](https://docs.veloconnect.me/36987894e0.md): Returns the click totals of one link and a list of its single clicks, newest first. - Link Shortener > Links [Create a short link](https://docs.veloconnect.me/36987895e0.md): Creates a short link that sends visitors to a long address and counts the clicks. Use it to put a short, trackable link into an SMS or another message. - Link Shortener > Links [Get a link by code](https://docs.veloconnect.me/36987896e0.md): Returns one of your links, found by its code: the last part of the short address. Use it when you kept the short address but not the link `id`. - Link Shortener > Links [Get a link](https://docs.veloconnect.me/36987897e0.md): Returns the settings of one of your links by its `id`. Use it to check where a link points and whether it is still active. - Link Shortener > Links [Update a link](https://docs.veloconnect.me/36987898e0.md): Changes a link: where it points, whether it is active, its expiry time, click limit, grouping ids, metadata and tags. - Link Shortener > Links [Delete a link](https://docs.veloconnect.me/36987899e0.md): Deletes one of your links. The short address stops working at once: from then on it answers 404. - Link Shortener > Redirect [Open a short link](https://docs.veloconnect.me/36987905e0.md): This is the short link itself: the address you put into your messages. When a visitor opens it, the service counts the click and sends the browser on to the destination of the link. Your program does not need to call it. - Account > Profile [Get your account profile](https://docs.veloconnect.me/36987928e0.md): Returns the profile of the account you are signed in with: contact details, company details, currency and balance. Use it to check which account a login token belongs to, or to read the balance. - Account > Authentication [Sign in (for programs)](https://docs.veloconnect.me/44918231e0.md): Signs a program in and returns a login token. Every call in this reference that asks for a login token takes it in the header `Authorization: Bearer `. - Account > Authentication [Refresh the login token](https://docs.veloconnect.me/44918232e0.md): Returns a new login token and a new refresh token. - Account > Authentication [Sign out](https://docs.veloconnect.me/44918233e0.md): Ends the session on the server: the account's refresh tokens stop working. Send the login token as the bearer token. - Templates & Content > Templates [Create a message template](https://docs.veloconnect.me/36987945e0.md): Creates a message template for one channel. A template keeps a text you send often, so that a campaign can use it by id. - Templates & Content > Templates [List message templates](https://docs.veloconnect.me/36987946e0.md): Returns the message templates of your account, page by page. Use it to find the id of a template or to check whether a template can be used. - Templates & Content > Templates [Update a message template](https://docs.veloconnect.me/36987947e0.md): Changes the name and the text of a template of your account. - Templates & Content > Templates [Delete a message template](https://docs.veloconnect.me/36987948e0.md): Deletes a template of your account. This cannot be undone, and the campaigns that were created with the template are deleted together with it. - Templates & Content > Templates [Get a message template](https://docs.veloconnect.me/36987949e0.md): Returns one message template of your account: its text, channel, status and attached files. - Sender IDs & Pricing > Reference Data [List trunks](https://docs.veloconnect.me/36987952e0.md): Lists the trunks of your account. A trunk ties your account to one rate plan (price list) for SMS, and an SMS campaign needs a trunk id. - Sender IDs & Pricing > Reference Data [List mobile operators](https://docs.veloconnect.me/36987953e0.md): Lists the mobile operators of one country, each with the fee for registering a sender name with it. Use it before you request a sender name: it gives the operator codes to send and shows which documents each operator asks for. - Sender IDs & Pricing > Rates [List message rates](https://docs.veloconnect.me/36987954e0.md): Lists the prices of your account's rate plans, by mobile operator. Use it to show or check what a message costs before you send. - Sender IDs & Pricing > Sender IDs [Request a sender name](https://docs.veloconnect.me/36987956e0.md): Asks VeloConnect to register a new sender name: the name or number your messages come from. The request is saved with status `Pending`; VeloConnect staff review it and approve or decline it. You can send with the name after it is approved (status `Active`). - Sender IDs & Pricing > Sender IDs [List sender names](https://docs.veloconnect.me/36987957e0.md): Lists the sender names of your company with their status, newest first. Use it to find the `id` of an approved sender name: a campaign channel needs it as `senderId`. - Sender IDs & Pricing > Sender IDs [Delete a sender name](https://docs.veloconnect.me/36987958e0.md): Deletes one of your company's sender names, or a request that is still waiting. Use it when you no longer need the name. - Sender IDs & Pricing > Sender IDs [Get a sender name](https://docs.veloconnect.me/36987959e0.md): Returns one sender name of your company with its status, the operators it was requested for and the uploaded documents. Use it to follow a request after you sent it. - Email Messaging > Delivery Records [Export e-mail records](https://docs.veloconnect.me/36988006e0.md): Exports the e-mail records of your account as a CSV file. Use it for reports; to read records in a program, use the list call (`POST /api/email-data-records/list`). - Email Messaging > Delivery Records [List e-mail records](https://docs.veloconnect.me/36988007e0.md): Lists the e-mail records of your account: one record for each e-mail sent by a campaign, with its recipient, state and price. Use it to follow the result of an e-mail campaign. - Email Messaging > Delivery Records [Get an e-mail record](https://docs.veloconnect.me/36988008e0.md): Returns one e-mail record of your account by its id. Use it to read the state of a single e-mail again. - Email Messaging > Pricing [List e-mail prices](https://docs.veloconnect.me/36988009e0.md): Returns the price of one e-mail in each currency. Use it to work out the cost of an e-mail campaign before you send it. - Notifications & Statistics > Statistics [List balance history](https://docs.veloconnect.me/36988013e0.md): Returns how your balance changed over a period: one entry for each recorded balance, newest first. Use it to draw a balance chart or to see what the balance was at a given time. - Notifications & Statistics > Statistics [Get sender name expenses](https://docs.veloconnect.me/36988014e0.md): Returns what your account paid for sender names in a period: the number of charges and their total. Use it for a spending report. - API Integration [Get the API key](https://docs.veloconnect.me/36988015e0.md): Returns the API key of your company. The key is what the messaging calls (SMS, Viber, WhatsApp) take as `api_id` or in the `apiId` header. - API Integration [Replace the API key](https://docs.veloconnect.me/36988016e0.md): Creates a new API key for your company and returns it. **The old key stops working at once**, so every integration that still uses it is refused until it gets the new key. - API Integration [Get the allowed IP addresses](https://docs.veloconnect.me/36988017e0.md): Returns the list of IP addresses that may use your API key. - API Integration [Set the allowed IP addresses](https://docs.veloconnect.me/36988018e0.md): Replaces the list of IP addresses that may use your API key. Calls with the key from any other address are refused with 401. - Payments > Payments [List payments](https://docs.veloconnect.me/36988020e0.md): Lists the money movements of your account, newest first: top-ups as positive amounts and charges, such as sender name fees, as negative amounts. This call only reads history; you add money in the dashboard. - Payments > Payments [Get a payment](https://docs.veloconnect.me/36988022e0.md): Returns one payment of your account by its id. Use it to check the status of a top-up or to show one row of the payment list in full. - SMS Messaging > Conversations [List SMS conversations](https://docs.veloconnect.me/36988027e0.md): Lists the two-way SMS conversations of your account. A conversation starts when a person answers a message you sent, or writes to one of your numbers. Use it to build an inbox of replies. - SMS Messaging > Conversations [List conversation messages](https://docs.veloconnect.me/36988028e0.md): Lists the messages of one SMS conversation, newest first. Use it to show a conversation after you picked it from the conversation list. - SMS Messaging > Delivery Records [Export SMS records](https://docs.veloconnect.me/36988030e0.md): Exports the SMS records of your account as a CSV file: one line for each SMS sent, with its delivery result. Use it for reports. - Social Platform > Connections [List social connections](https://docs.veloconnect.me/36988032e0.md): Lists the Facebook and Instagram sign-ins that are connected to your account, each with its channels. A connection is one sign-in at Meta. A channel is one Facebook Page or Instagram business account that the sign-in gave access to. Start here to get the channel ids for the conversation calls. - Social Platform > Connections [Get a channel](https://docs.veloconnect.me/36988033e0.md): Returns one channel: a Facebook Page or an Instagram business account that you connected. Channels that are no longer active are returned too. - Social Platform > Connections [Disconnect a channel](https://docs.veloconnect.me/36988034e0.md): Switches off one channel and leaves the rest of its connection as it is. Use it when one Page or Instagram account should no longer be handled in VeloConnect. - Social Platform > Connections [Check channel subscription status](https://docs.veloconnect.me/36988035e0.md): Shows whether new messages of a channel reach the VeloConnect inbox on their own. When a channel is connected, VeloConnect asks Facebook or Instagram to send it every new message of that channel. This call returns the result of the last such request. - Social Platform > Connections [Get a connection](https://docs.veloconnect.me/36988036e0.md): Returns one connection with its active channels. Use it to check that a connection is still in use and how long its authorization at Meta lasts (`tokenStatus`, `tokenExpiresAtUtc`). - Social Platform > Connections [Disconnect a connection](https://docs.veloconnect.me/36988037e0.md): Switches off a whole connection: the sign-in at Meta and every channel under it. Use it when VeloConnect should stop handling that account. - Social Platform > Connections [Check a connection token](https://docs.veloconnect.me/36988038e0.md): Asks Facebook or Instagram whether the authorization stored for a connection is still valid, and updates `tokenStatus` and `tokenExpiresAtUtc` of the connection. Use it when replies or syncs start to fail, or to see how long the authorization still lasts. - Social Platform > Connections [Resync channels of a connection](https://docs.veloconnect.me/36988039e0.md): Asks Facebook or Instagram again which Pages and accounts a connection may use, and brings the channel list up to date. Use it after you add a Page, link an Instagram account to a Page, or change at Meta what the connection is allowed to see. - Social Platform > Connections [List supported providers](https://docs.veloconnect.me/36988040e0.md): Lists the social networks the social inbox works with, each with its number. The same numbers appear as `provider` in connections, channels, conversations and messages, and you can use them as a filter when you list conversations. - Social Platform > Inbox [List conversations of an account](https://docs.veloconnect.me/36988041e0.md): Lists the conversations of all your active channels in one list, the one with the newest message first. This is the call to poll for new messages: VeloConnect does not send them to your system. - Social Platform > Inbox [List conversations of a channel](https://docs.veloconnect.me/36988042e0.md): Lists the conversations of one channel, the one with the newest message first. - Social Platform > Inbox [Sync conversations of a channel](https://docs.veloconnect.me/36988043e0.md): Loads the conversation list of a channel from Facebook or Instagram into the VeloConnect inbox. New messages normally arrive on their own, so use this call only to catch up: after a channel is connected, to bring in the conversations that already exist, or while the subscription status shows that messages are not arriving. - Social Platform > Inbox [Get a conversation](https://docs.veloconnect.me/36988044e0.md): Returns one conversation: who the customer is, which channel it belongs to, its workflow status, and the time and preview of the last message. Unlike the list calls it also returns conversations of channels that are no longer active. - Social Platform > Inbox [Get conversation status history](https://docs.veloconnect.me/36988047e0.md): Lists the workflow steps of a conversation, oldest first: when it was created, assigned, started, resolved, closed and reopened, and by which user. - Social Platform > Inbox [Mark a conversation as read](https://docs.veloconnect.me/36988048e0.md): Marks a conversation as read by your side. The conversation gets `isUnread: false`, its customer messages get `status` `4` (read), and VeloConnect tells Facebook or Instagram, so the customer sees the messages as seen. - Social Platform > Inbox [List messages of a conversation](https://docs.veloconnect.me/36988049e0.md): Returns all messages of a conversation, oldest first: what the customer wrote and what your side answered. - Social Platform > Inbox [Reply to a conversation](https://docs.veloconnect.me/36988051e0.md): Sends a reply to the customer of a conversation, through the Facebook Page or Instagram account the conversation belongs to. You can send text, files, or both. - Social Platform > Inbox [Sync messages of a conversation](https://docs.veloconnect.me/36988054e0.md): Loads the messages of one conversation from Facebook or Instagram into the VeloConnect inbox. New messages normally arrive on their own, so use this call to catch up: to bring in the earlier messages of a conversation that came from a conversation sync, or when you think a message is missing. - Campaigns (v2) > Campaigns [Create a campaign](https://docs.veloconnect.me/36988067e0.md): Creates a campaign: one message for a list of recipients, sent on one or more channels, at once or at a time you choose. This is the main sending call of the v2 API. Use it for a single recipient as well as for a large list. - Campaigns (v2) > Campaigns [Export campaigns to CSV](https://docs.veloconnect.me/36988068e0.md): Downloads your campaigns as a CSV file. Use it to take the campaign list into a spreadsheet or a report. - Campaigns (v2) > Campaigns [List campaigns](https://docs.veloconnect.me/36988069e0.md): Returns your campaigns one page at a time, newest first unless you sort differently. Use it to show a campaign table or to find a campaign id. - Campaigns (v2) > Campaigns [Get a campaign](https://docs.veloconnect.me/36988070e0.md): Returns one campaign: its settings, its status and the sending counters of every channel. Call it after you create a campaign to follow the progress and to read the result. - Campaigns (v2) > Campaigns [Update a campaign](https://docs.veloconnect.me/36988071e0.md): Replaces the definition of a campaign: its name, schedule, recipients and channels. Use it to change a campaign that has not started yet, that is, while its status is `Scheduled`. - Campaigns (v2) > Tools & Pricing [Count SMS parts](https://docs.veloconnect.me/36988073e0.md): Counts the characters of an SMS text and tells you how many parts it takes. Nothing is sent and nothing is saved. Use it to show a counter while a user types a message. - Campaigns (v2) > Tools & Pricing [Calculate campaign price](https://docs.veloconnect.me/36988076e0.md): Returns the price of the messages a campaign still has to send, in total and for each channel, with the number of recipients and messages behind it. - Campaigns (v2) > Tools & Pricing [Preview campaign recipients](https://docs.veloconnect.me/36988077e0.md): Works out who a campaign would reach right now: how many recipients can be reached, on which channel each of them would start, and which recipients cannot be reached and why. Nothing is sent and nothing is saved. Use it before a campaign starts to check its segments and channels. - Contacts (v2) > Contacts [Create a contact](https://docs.veloconnect.me/36988082e0.md): Creates one contact in your company's contact list. A contact is a person with profile fields and a list of details: the phone numbers, e-mail addresses and messenger ids you can reach them on. - Contacts (v2) > Contacts [Export contacts](https://docs.veloconnect.me/36988083e0.md): Downloads your company's contacts as a CSV file. Use it for a backup or to move contacts to another system. - Contacts (v2) > Contacts [Import contacts from CSV](https://docs.veloconnect.me/36988084e0.md): Creates many contacts from one CSV file. It can add them to a segment in the same call. - Contacts (v2) > Contacts [List contacts](https://docs.veloconnect.me/36988085e0.md): Lists your company's contacts with their details, one page at a time. Use it to search for a person or to read a filtered part of the contact list. - Contacts (v2) > Contacts [Get a contact](https://docs.veloconnect.me/36988086e0.md): Returns one contact of your company with all its details: phone numbers, e-mail addresses and the other ways to reach the person. - Contacts (v2) > Contacts [Update a contact](https://docs.veloconnect.me/36988087e0.md): Replaces the profile fields of one contact: names, date of birth, gender, company, job title, notes and your external reference. - Contacts (v2) > Contacts [Delete a contact](https://docs.veloconnect.me/36988088e0.md): Deletes one contact of your company. After that the contact calls no longer return it, and it is left out of contact lists and exports. - Contacts (v2) > Details [Add a contact detail](https://docs.veloconnect.me/36988089e0.md): Adds one way to reach an existing contact: a phone number, an e-mail address or a messenger id. - Contacts (v2) > Details [Export contact details](https://docs.veloconnect.me/36988090e0.md): Downloads the details of one contact (phone numbers, e-mail addresses, messenger ids) as a CSV file. - Contacts (v2) > Details [List contact details](https://docs.veloconnect.me/36988091e0.md): Lists the details of one contact (phone numbers, e-mail addresses, messenger ids), one page at a time, with optional filters. - Contacts (v2) > Details [Update a contact detail](https://docs.veloconnect.me/36988092e0.md): Replaces one detail of a contact: its type, value, label, primary flag, verified flag and status. - Contacts (v2) > Messages [Export a contact's messages](https://docs.veloconnect.me/36988093e0.md): Downloads the campaign messages sent to one contact as a CSV file, one row for each send attempt. - Contacts (v2) > Messages [List a contact's messages](https://docs.veloconnect.me/36988094e0.md): Lists the campaign messages sent to one contact, one row for each send attempt, with the channel, the status, the times and the text that was sent. Use it to show a contact's message history. - Dashboard (v2) [Get channel breakdown](https://docs.veloconnect.me/36988095e0.md): Returns the totals of a period split by channel, the number of campaigns in each status and the message volume per channel. Use it for bar and pie charts of your traffic. - Dashboard (v2) [Get headline statistics](https://docs.veloconnect.me/36988096e0.md): Returns the main figures of your account for a period: messages sent and delivered, the delivery rate, the amount charged, the expected price of campaigns that are still waiting, and your balance now. - Dashboard (v2) [Get OTP statistics](https://docs.veloconnect.me/36988097e0.md): Returns the figures for one-time-password (OTP) messages only, one row per channel: how many were sent and what share was delivered. For Telegram it also tells how many codes were verified. - Dashboard (v2) [Get message trends](https://docs.veloconnect.me/36988098e0.md): Returns the number of messages sent, delivered and failed for each day, week or month of a period, split by channel. Use it to draw a chart over time. - Segments (v2) [Create a segment](https://docs.veloconnect.me/36988099e0.md): Creates a segment: a named list of your contacts that campaigns can send to. Use it to group contacts before you create a campaign. - Segments (v2) [Export segments to CSV](https://docs.veloconnect.me/36988100e0.md): Downloads your segments as a CSV file. Use it to take the segment list into a spreadsheet. - Segments (v2) [List segments](https://docs.veloconnect.me/36988101e0.md): Returns your segments one page at a time, newest first unless you sort differently. Use it to find a segment id or to show a segment table. - Segments (v2) [Get a segment](https://docs.veloconnect.me/36988102e0.md): Returns one segment with its counters: how many contacts it has, how they split by gender, and how many have a phone number or an e-mail address. Use it to check a segment before you send to it. - Segments (v2) [Update a segment](https://docs.veloconnect.me/36988103e0.md): Changes the name and the description of a segment. The contacts in it stay as they are; change them with the add and remove calls. - Segments (v2) [Delete a segment](https://docs.veloconnect.me/36988104e0.md): Deletes a segment for good. The contacts that were in it are not deleted; they are only no longer grouped by this segment. - Segments (v2) [Add contacts to a segment](https://docs.veloconnect.me/36988105e0.md): Adds contacts to a segment. Use it to fill a segment after you create it, or to keep it up to date. - Segments (v2) [Remove contacts from a segment](https://docs.veloconnect.me/36988106e0.md): Takes contacts out of a segment. The contacts themselves are not deleted. ## Schemas - [TemplateFilteringSortingModel](https://docs.veloconnect.me/15403625d0.md): - [SocialChannelType](https://docs.veloconnect.me/15403610d0.md): - [V2ContactDetailType](https://docs.veloconnect.me/15403508d0.md): - [CommunicationType](https://docs.veloconnect.me/15403637d0.md): - [RateFilteringSortingModel](https://docs.veloconnect.me/15403588d0.md): - [PagedListGetModelOfV2ContactGetModel](https://docs.veloconnect.me/15403553d0.md): - [SuccessResponseModelOfPagedListGetModelOfRateGetModel](https://docs.veloconnect.me/15403419d0.md): - [SenderIdFilteringSortingModel](https://docs.veloconnect.me/15403557d0.md): - [V2CampaignChannelGetModel](https://docs.veloconnect.me/15403631d0.md): - [V2CampaignExportRequestModel](https://docs.veloconnect.me/15403492d0.md): - [WebhookSubscriptionStatusDto](https://docs.veloconnect.me/15403329d0.md): - [SocialProvider](https://docs.veloconnect.me/15403344d0.md): - [V2CampaignChannelUpdateModel](https://docs.veloconnect.me/15403578d0.md): - [SuccessResponseModelOfSenderIdGetModel](https://docs.veloconnect.me/15403516d0.md): - [V2SegmentUpdateModel](https://docs.veloconnect.me/15403493d0.md): - [V2ContactCsvDuplicateModel](https://docs.veloconnect.me/15403596d0.md): - [PagedListGetModelOfRateGetModel](https://docs.veloconnect.me/15403525d0.md): - [V2ContactMessageExportRequestModel](https://docs.veloconnect.me/15403558d0.md): - [V2DashboardTrendsChannelModel](https://docs.veloconnect.me/15403351d0.md): - [DataRecordFilterModel](https://docs.veloconnect.me/15403426d0.md): - [SyncConversationsResponseDto](https://docs.veloconnect.me/15403526d0.md): - [ClickEventDto](https://docs.veloconnect.me/15403461d0.md): - [PagedListGetModelOfV2CampaignListItemModel](https://docs.veloconnect.me/15403333d0.md): - [SocialConnectionDto](https://docs.veloconnect.me/15403487d0.md): - [ErrorResponseModel](https://docs.veloconnect.me/15403373d0.md): - [V2ContactCreateModel](https://docs.veloconnect.me/15403616d0.md): - [V2SegmentContactsUpdateModel](https://docs.veloconnect.me/15403380d0.md): - [TokenStatus](https://docs.veloconnect.me/15403589d0.md): - [SuccessResponseModelOfV2ContactCsvImportResultModel](https://docs.veloconnect.me/15403317d0.md): - [SuccessResponseModelOfEmailPriceGetModel](https://docs.veloconnect.me/15403544d0.md): - [CustomerUserGetModel](https://docs.veloconnect.me/15403613d0.md): - [V2ContactCsvImportResultModel](https://docs.veloconnect.me/15403640d0.md): - [V2ContactDetailCreateModel](https://docs.veloconnect.me/15403436d0.md): - [V2CampaignUpdateModel](https://docs.veloconnect.me/15403405d0.md): - [SocialConversationDto](https://docs.veloconnect.me/15403614d0.md): - [UnifiedInboxDto](https://docs.veloconnect.me/15403483d0.md): - [ProviderType](https://docs.veloconnect.me/15403451d0.md): - [CustomerUserLoginModel](https://docs.veloconnect.me/15403555d0.md): - [SuccessResponseModelOfCustomerUserLoginResultModel](https://docs.veloconnect.me/15403379d0.md): - [SuccessResponseModelOfV2CampaignGetModel](https://docs.veloconnect.me/15403342d0.md): - [SuccessResponseModelOfPagedListGetModelOfSmsConversationGetModel](https://docs.veloconnect.me/15403458d0.md): - [V2ContactDetailUpdateModel](https://docs.veloconnect.me/15403490d0.md): - [V2ContactUpdateModel](https://docs.veloconnect.me/15403475d0.md): - [WhatsAppStatus](https://docs.veloconnect.me/15403391d0.md): - [PagedListGetModelOfPaymentGetModel](https://docs.veloconnect.me/15403563d0.md): - [V2ContactDetailExportRequestModel](https://docs.veloconnect.me/15403520d0.md): - [EmailDataRecordGetModel](https://docs.veloconnect.me/15403599d0.md): - [SmsConversationGetModel](https://docs.veloconnect.me/15403518d0.md): - [SenderIdType](https://docs.veloconnect.me/15403370d0.md): - [LinkAnalyticsResponse](https://docs.veloconnect.me/15403527d0.md): - [CustomerUserLoginResultModel](https://docs.veloconnect.me/15403644d0.md): - [V2ContactMessageListFilterModel](https://docs.veloconnect.me/15403415d0.md): - [FilterComparer](https://docs.veloconnect.me/15403546d0.md): - [SuccessResponseModelOfV2SegmentGetModel](https://docs.veloconnect.me/15403530d0.md): - [PagedListGetModelOfV2ContactDetailGetModel](https://docs.veloconnect.me/15403332d0.md): - [SenderIdGetModel](https://docs.veloconnect.me/15403457d0.md): - [PaymentDirection](https://docs.veloconnect.me/15403396d0.md): - [TrafficType](https://docs.veloconnect.me/15403551d0.md): - [UpdateLinkRequest](https://docs.veloconnect.me/15403435d0.md): - [SuccessResponseModelOfPagedListGetModelOfV2CampaignListItemModel](https://docs.veloconnect.me/15403639d0.md): - [WhatsAppTemplateCategory](https://docs.veloconnect.me/15403320d0.md): - [PagedListGetModelOfSmsConversationGetModel](https://docs.veloconnect.me/15403584d0.md): - [V2SegmentListFilterModel](https://docs.veloconnect.me/15403488d0.md): - [ConversationStatus](https://docs.veloconnect.me/15403562d0.md): - [V2ExportMode](https://docs.veloconnect.me/15403425d0.md): - [V2SegmentGetModel](https://docs.veloconnect.me/15403389d0.md): - [V2ContactDetailListFilterModel](https://docs.veloconnect.me/15403335d0.md): - [SuccessResponseModelOfStatisticSenderIdExpensesGetModel](https://docs.veloconnect.me/15403424d0.md): - [SenderIdStatus](https://docs.veloconnect.me/15403331d0.md): - [PagedListGetModelOfV2ContactMessageListItemModel](https://docs.veloconnect.me/15403323d0.md): - [V2DashboardOtpStatsModel](https://docs.veloconnect.me/15403612d0.md): - [SuccessResponseModelOfPagedListGetModelOfSenderIdGetModel](https://docs.veloconnect.me/15403505d0.md): - [SuccessResponseModelOfStatisticBalanceGetModel](https://docs.veloconnect.me/15403606d0.md): - [StatisticSenderIdExpensesGetModel](https://docs.veloconnect.me/15403392d0.md): - [SocialMessageDto](https://docs.veloconnect.me/15403586d0.md): - [AdminUserGetModel](https://docs.veloconnect.me/15403559d0.md): - [PagedListGetModelOfTemplateGetModel](https://docs.veloconnect.me/15403430d0.md): - [SuccessResponseModelOfPagedListGetModelOfTemplateGetModel](https://docs.veloconnect.me/15403585d0.md): - [CreateLinkRequest](https://docs.veloconnect.me/15403529d0.md): - [ProblemDetails_link](https://docs.veloconnect.me/15403571d0.md): - [SenderIdTrafficTypeGetModel](https://docs.veloconnect.me/15403414d0.md): - [V2CampaignListItemModel](https://docs.veloconnect.me/15403552d0.md): - [SuccessResponseModelOfV2CampaignPricePreviewModel](https://docs.veloconnect.me/15403484d0.md): - [MessageStatus](https://docs.veloconnect.me/15403621d0.md): - [SenderIdTypeGetModel](https://docs.veloconnect.me/15403361d0.md): - [SocialChannelDto](https://docs.veloconnect.me/15403459d0.md): - [SuccessResponseModelOfPagedListGetModelOfAreaMccMncGetModel](https://docs.veloconnect.me/15403633d0.md): - [SuccessResponseModelOfV2CampaignMessageInfoModel](https://docs.veloconnect.me/15403499d0.md): - [TokenGetModel](https://docs.veloconnect.me/15403337d0.md): - [V2CampaignChannelCreateModel](https://docs.veloconnect.me/15403468d0.md): - [StatisticBalanceGetModel](https://docs.veloconnect.me/15403536d0.md): - [V2CampaignPricePreviewModel](https://docs.veloconnect.me/15403647d0.md): - [RateGetModel](https://docs.veloconnect.me/15403538d0.md): - [SocialConversationStatusHistoryDto](https://docs.veloconnect.me/15403545d0.md): - [SuccessResponseModelOfPaymentListGetModelOfPaymentGetModel](https://docs.veloconnect.me/15403355d0.md): - [V2SegmentCreateModel](https://docs.veloconnect.me/15403358d0.md): - [AreaMccMncFilterModel](https://docs.veloconnect.me/15403609d0.md): - [SuccessResponseModelOfString](https://docs.veloconnect.me/15403383d0.md): - [MessageDirection](https://docs.veloconnect.me/15403446d0.md): - [TokenRefreshModel](https://docs.veloconnect.me/15403629d0.md): - [PagedListGetModelOfEmailDataRecordGetModel](https://docs.veloconnect.me/15403541d0.md): - [SocialProviderDto](https://docs.veloconnect.me/15403368d0.md): - [EmailPriceGetModel](https://docs.veloconnect.me/15403482d0.md): - [ResyncChannelsResponseDto](https://docs.veloconnect.me/15403431d0.md): - [SenderIdMediaAttachmentGetModel](https://docs.veloconnect.me/15403601d0.md): - [TemplateUpdateModel](https://docs.veloconnect.me/15403611d0.md): - [SuccessResponseModelOfPagedListGetModelOfV2SegmentGetModel](https://docs.veloconnect.me/15403576d0.md): - [IFormFile](https://docs.veloconnect.me/15403434d0.md): - [V2CampaignGetModel](https://docs.veloconnect.me/15403507d0.md): - [PagedListGetModelOfSenderIdPriceGetModel](https://docs.veloconnect.me/15403448d0.md): - [SuccessResponseModelOfEmailDataRecordGetModel](https://docs.veloconnect.me/15403641d0.md): - [PagedListGetModelOfV2SegmentGetModel](https://docs.veloconnect.me/15403371d0.md): - [PartnerCustomerUserLoginModel](https://docs.veloconnect.me/15403465d0.md): - [V2ContactExportRequestModel](https://docs.veloconnect.me/15403348d0.md): - [SuccessResponseModelOfTokenGetModel](https://docs.veloconnect.me/15403648d0.md): - [PaginationModel](https://docs.veloconnect.me/15403410d0.md): - [SyncMessagesResponseDto](https://docs.veloconnect.me/15403324d0.md): - [SuccessResponseModelOfIEnumerableOfLong](https://docs.veloconnect.me/15403635d0.md): - [SuccessResponseModelOfPaymentGetModel](https://docs.veloconnect.me/15403598d0.md): - [SortingModel](https://docs.veloconnect.me/15403642d0.md): - [V2CampaignChannelSummaryModel](https://docs.veloconnect.me/15403407d0.md): - [SenderIdPriceGetModel](https://docs.veloconnect.me/15403328d0.md): - [V2SegmentExportRequestModel](https://docs.veloconnect.me/15403617d0.md): - [V2DashboardKpisModel](https://docs.veloconnect.me/15403623d0.md): - [SuccessResponseModelOfTemplateGetModel](https://docs.veloconnect.me/15403512d0.md): - [V2CampaignMessageInfoModel](https://docs.veloconnect.me/15403587d0.md): - [AreaMccMncGetModel](https://docs.veloconnect.me/15403594d0.md): - [V2DashboardOtpChannelModel](https://docs.veloconnect.me/15403363d0.md): - [CampaignAnalyticsListRequest](https://docs.veloconnect.me/15403573d0.md): - [PaymentListGetModelOfPaymentGetModel](https://docs.veloconnect.me/15403646d0.md): - [ReplyMessageResponseDto](https://docs.veloconnect.me/15403345d0.md): - [V2ContactDetailGetModel](https://docs.veloconnect.me/15403403d0.md): - [V2DashboardChannelBreakdownModel](https://docs.veloconnect.me/15403567d0.md): - [ContactAnalyticsResponse](https://docs.veloconnect.me/15403401d0.md): - [SuccessResponseModelOfLong](https://docs.veloconnect.me/15403591d0.md): - [LinkResponse](https://docs.veloconnect.me/15403338d0.md): - [SuccessResponseModelOfCustomerUserGetModel](https://docs.veloconnect.me/15403602d0.md): - [V2ContactGetModel](https://docs.veloconnect.me/15403643d0.md): - [SuccessResponseModelOfBoolean](https://docs.veloconnect.me/15403566d0.md): - [V2ContactDetailStatus](https://docs.veloconnect.me/15403539d0.md): - [SuccessResponseModelOfPagedListGetModelOfSenderIdPriceGetModel](https://docs.veloconnect.me/15403395d0.md): - [V2CampaignChannelPricePreviewModel](https://docs.veloconnect.me/15403619d0.md): - [PagedListGetModelOfSenderIdGetModel](https://docs.veloconnect.me/15403597d0.md): - [V2DashboardTrendsDataPointModel](https://docs.veloconnect.me/15403321d0.md): - [TemplateGetBaseModel](https://docs.veloconnect.me/15403504d0.md): - [SenderIdViberLogoGetModel](https://docs.veloconnect.me/15403456d0.md): - [V2DashboardChannelFunnelModel](https://docs.veloconnect.me/15403449d0.md): - [TemplateGetModel](https://docs.veloconnect.me/15403535d0.md): - [ConversationStatusHistoryActionType](https://docs.veloconnect.me/15403626d0.md): - [PaymentGetModel](https://docs.veloconnect.me/15403645d0.md): - [V2CampaignListFilterModel](https://docs.veloconnect.me/15403394d0.md): - [CustomerTrunkBaseGetModel](https://docs.veloconnect.me/15403452d0.md): - [CampaignAnalyticsResponse](https://docs.veloconnect.me/15403377d0.md): - [V2CampaignCreateModel](https://docs.veloconnect.me/15403322d0.md): - [BusinessType](https://docs.veloconnect.me/15403477d0.md): - [PaymentFilterModel](https://docs.veloconnect.me/15403375d0.md): - [V2CampaignMessageInfoRequest](https://docs.veloconnect.me/15403330d0.md): - [TemplateMediaAttachmentGetModel](https://docs.veloconnect.me/15403570d0.md): - [SuccessResponseModelOfV2CampaignRecipientPreviewModel](https://docs.veloconnect.me/15403399d0.md): - [FilteringModel](https://docs.veloconnect.me/15403514d0.md): - [MessageType](https://docs.veloconnect.me/15403480d0.md): - [SuccessResponseModelOfPagedListGetModelOfV2ContactMessageListItemModel](https://docs.veloconnect.me/15403583d0.md): - [TemplateStatus](https://docs.veloconnect.me/15403327d0.md): - [SuccessResponseModelOfCustomerTrunkBaseGetModel](https://docs.veloconnect.me/15403501d0.md): - [FilteringSortingModel](https://docs.veloconnect.me/15403574d0.md): - [V2ContactListFilterModel](https://docs.veloconnect.me/15403349d0.md): - [V2DashboardTrendsModel](https://docs.veloconnect.me/15403494d0.md): - [V2ContactMessageListItemModel](https://docs.veloconnect.me/15403620d0.md): - [ConversationFilteringSortingModel](https://docs.veloconnect.me/15403474d0.md): - [SuccessResponseModelOfPagedListGetModelOfEmailDataRecordGetModel](https://docs.veloconnect.me/15403511d0.md): - [V2CampaignRecipientPreviewModel](https://docs.veloconnect.me/15403517d0.md): - [SuccessResponseModelOfV2ContactGetModel](https://docs.veloconnect.me/15403579d0.md): - [SuccessResponseModelOfPagedListGetModelOfV2ContactDetailGetModel](https://docs.veloconnect.me/15403354d0.md): - [SortDirection](https://docs.veloconnect.me/15403362d0.md): - [PagedListGetModelOfAreaMccMncGetModel](https://docs.veloconnect.me/15403537d0.md): - [V2CampaignUnresolvableRecipientModel](https://docs.veloconnect.me/15403398d0.md): - [RateDetailGetModel](https://docs.veloconnect.me/15403387d0.md): - [RefreshTokenResponseDto](https://docs.veloconnect.me/15403630d0.md): - [SuccessResponseModelOfPagedListGetModelOfV2ContactGetModel](https://docs.veloconnect.me/15403624d0.md):