1. Session
VeloConnect CCaaS API
  • Programmatic API (API Key)
    • Account & Pricing
      • Calculate SMS Campaign Price
      • Check balance.
      • Check balance.
      • Get Rate plans
    • Sender IDs
      • Get senderId's list.
      • Get senderId's list.
      • SenderId status.
      • SenderId status.
    • Send SMS
      • Send SMS.
      • Send SMS.
      • Send SMS multi.
      • Send SMS multi.
    • OTP Verification
      • Send verification SMS.
      • Send verification SMS.
      • Verify OTP code.
      • Verify OTP code.
    • SMS Status
      • Get SMS Details
      • Get SMS Details by Id
    • WhatsApp
      • senders
        • Returns sender ids
      • 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-conversations
        • {id}
          • messages
            • Returns conversation messages
        • Returns conversations
      • whatsapp-messages
        • Sends a message
      • whatsapp-templates
        • {id}
          • Deletes template
        • Creates new template
        • Returns templates
    • Viber Business Messaging
      • 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
        • Sends a Viber message
        • Returns viber conversations messages
      • Records
        • Returns the list of viber message data records
        • Returns viber message data record by ID
      • Summaries
        • Return messages summaries
      • OTP
        • OTP Message
          • Send OTP
        • OTP Templates
          • Get OTP Templates
      • Senders
        • Viber Sender by id
        • Viber Senders
      • Viber Templates
        • Create template
        • List templates
        • Delete Template
        • Get Template
  • Link Shortener
    • Analytics
      • Get campaign analytics list
      • Get campaign analytics
      • Get contact analytics
      • Get link analytics
    • Links
      • Create a short link
      • Get a link by short code
      • Get a link by id
      • Update a link
      • Delete a link
    • Webhooks
      • List webhook deliveries
      • Create a webhook subscription
      • List webhook subscriptions
      • Update a webhook subscription
      • Delete a webhook subscription
    • Redirect
      • Resolve a short link
  • Account
    • Team Members
      • Gets all business members for the current business (invited, active, deactivated). Invited appear first.
      • Assigns a sender ID to a business member
      • Invites a new member to the business by email. Only the business (owner) can invite.
      • Gets all businesses where the current user is a member
      • Updates the full set of sender IDs assigned to a business member
      • Gets a single business member by id (including assigned senders)
      • Deactivates a team member and restricts their access
    • Registration
      • Accepts a team member invitation using the token (no auth required).
      • Registers new customer user
      • Registers new customer user with email only
    • Reference Data
      • Returns the list of currencies
    • Authentication
      • Logs in using 2FA
      • Logs in
      • Logs out
      • Logs in a partner via API without captcha verification
      • Refreshes token
      • Logs in using SMS 2FA
    • Verification & Password
      • Confirms email address
      • Sends email address confirmation code
      • Resets customer user password
      • Confirms phone number
      • Sends phone number confirmation code
    • Profile
      • Returns current customer user
      • Returns customer user
      • Updates customer user info
      • Marks customer user as deleted
      • Updates customer user admin For remove admin set adminId to null
      • Updates customer user company info
      • Updates customer user email and sends confirmation code to the new email
      • Updates customer user open sender
      • Updates customer user password
      • Updates customer user phone number and sends confirmation code to the new phone number
    • Two-Factor
      • Returns customer user 2FA settings
      • Updates customer user 2FA settings
  • Templates & Content
    • Canned Responses
      • Creates a new canned response
      • Returns a list canned responses
      • Returns canned response by Id
      • Updates an canned response
      • Deletes message specified Id
    • Templates
      • Creates a new template
      • Returns the list of Templates
      • Updates the Template
      • Deletes the Template
      • Returns Template
    • Uploads
      • Uploads image
  • Sender IDs & Pricing
    • Reference Data
      • Returns countries
      • Returns the list of customerTrunks
      • Return all operators.
    • Rates
      • Returns rates
    • Sender IDs
      • Returns the list of sender id prices
      • Creates a new SenderId
      • Returns the list of SenderIds
      • Deletes the SenderId
      • Returns SenderId by id
  • Telephony
    • DID Numbers
      • Purchase & Provisioning
        • Assign purchased DID to tenant/user
        • Provision DID into SIP
        • Create a DID order for an available DID or an existing reservation.
      • Assignments
        • List DID assignments owned by the caller's scope, optionally filtered by tenant or assigned user.
        • One-shot health check for every assignment in the caller's scope. Returns per-DID SIP state flags so the FE can flag rows whose DB status says "Provisioned" but whose actual SIP routing is missing (drift caused by manual admin changes, bad cancels, etc.).
        • Returns the caller's DID-management permissions for their active tenant. Used by the FE to gate scope-edit UI without second-guessing JWT roles or user-object shapes.
        • Get a single DID assignment including its stored SIP password.
        • Update fields on a DID assignment. ExtensionNumber is optional; null leaves the existing value untouched. SIP credentials live on the PbxTenant — rotate them via PUT /api/pbx-tenants/{id}.
        • Unassign a DID — removes the assignment row. Does not cancel the underlying purchase order.
        • Cancel a purchased DID and trigger a wallet refund. Tears down the SIP routing for the DID (inbound rule, trunk assignees, user outbound_caller_ids entry), cancels the DID order, and removes the local assignment row. The wallet refund itself lands when re
        • Re-runs SIP provisioning for an existing assignment. Idempotent: safe to call repeatedly. Use to recover from drift when the DB says Provisioned but inbound calls don't land.
        • Replace the scope of a DID assignment. Body is { scope, userIds? } where scope is one of "Unassigned", "Business", "Users". userIds is required when scope = Users and must be empty otherwise. The set is replaced atomically — passing a different list wipes
        • Set this assignment's DID as the user's preferred outbound caller ID on SIP. Other DIDs keep working for inbound, but outbound calls from the extension will now stamp this number.
      • Catalog
        • List DID cities for a selected country or region.
        • List DID countries that can be used to build a search flow.
        • List DID DID groups that can later be used for available DID searches.
        • Get DID compliance requirements for a country and DID group type.
        • Search available DID numbers from DID using country, city, group, and number filters.
      • Compliance
        • Create compliance request
        • Get compliance request status
      • Orders
        • List DID orders.
        • Get a single DID order by external order id.
        • Cancel a DID order.
      • Reservations
        • Reserve an available DID before ordering it.
        • List DID reservations, optionally filtered by reservation id or available DID id.
        • Get a single DID reservation by id.
        • Cancel a DID reservation.
    • PBX Tenants
      • Creates new PbxTenant request
      • Returns PbxTenants
      • Configures webhook
      • Returns webhook data
      • Returns PbxTenant by id
    • SIP Voice
      • Monitoring
        • Real-time presence snapshot
        • Queue state for dashboard widget
        • Returns the caller's tenant CDRs (call detail records), paged. Scoped to the active PbxTenant resolved from the JWT access scope — no partner credentials required. Mirrors the partner-API GET /api/partners/pbx-cdrs but with user-context auth, suitable for
        • Get presence snapshot for tenant users/extensions
        • Get queue state snapshot
        • Get voicemail summary
      • Calls
        • Place call on hold
        • Transfer call to internal extension
        • Mute call audio
        • Initiate outbound call
        • Resume held call
        • Transfer active call
        • Unmute call audio
      • Session
        • Initialise WebRTC/SIP session
          POST
  • Email Messaging
    • Delivery Records
      • Exports email data records to a CSV file
      • Returns the list of email data records by user id
      • Returns email data record by id
    • Pricing
      • Returns email prices
  • Notifications & Statistics
    • Notifications
      • Returns notification histories
      • Marks a notification(s) as read by its id or all if id is not specified
      • Returns notification histories
    • Statistics
      • Returns balances
      • Returns SenderId expenses
  • API Integration
    • Returns the API key
    • Returns the regenerated API key
    • Returns the list of whitelisted ip's
    • Updates the list of whitelisted ip's
  • Payments
    • Payments
      • Creates new payment
      • Returns the list of payments
      • Exports payments to a CSV file
      • Returns payment
    • Provider Callbacks
      • Updates Crypto payment status
      • Cancels stripe payment
      • Confirms stripe payment
      • Updates wire payment status
  • SMS Messaging
    • Conversations
      • Returns an inbox sms conversations
      • Returns sms conversation messages
    • Delivery Records
      • Returns the list of sms data records by user id
      • Exports sms data records to a CSV file
      • Returns sms data record by id
  • Social Platform
    • Connections
      • Lists all social connections for an internal account.
      • Returns one social channel by identifier.
      • Disconnects a single channel without removing the full provider connection.
      • Returns the latest webhook subscription status known for a channel.
      • Returns one provider connection by identifier.
      • Disconnects an entire provider connection and all related channels.
      • Refreshes provider tokens for a connection when the provider supports token refresh.
      • Re-discovers channels for an existing connection.
      • Returns the list of social providers supported by this API.
    • Inbox
      • Returns the unified inbox for an internal account with optional provider, channel, and unread filters.
      • Lists normalized conversations for a channel.
      • Pulls the latest provider conversations for a channel into the normalized inbox.
      • Returns one normalized conversation.
      • Assigns or reassigns a conversation to an internal user.
      • Closes a resolved conversation.
      • Returns workflow history for a conversation.
      • Marks the conversation as read by the business. Sends sender_action=mark_seen to Meta so the customer sees a "Seen" indicator, and clears the local IsUnread flag plus per-message Read status. Idempotent.
      • Lists normalized messages for a conversation.
      • Reopens a resolved or closed conversation back into the assigned state.
      • Sends a reply through the underlying provider and stores the outgoing message locally. Submit as multipart/form-data with optional `Text` and zero or more `Attachments` file parts. At least one of text or attachments is required. Each attachment must be 2
      • Resolves an assigned or in-progress conversation.
      • Moves an assigned conversation into the in-progress workflow state.
      • Pulls the latest provider messages for a conversation.
    • Facebook
      • Starts the Facebook connect flow by generating a provider authorization URL. Optionally accepts a redirectUri to override the platform default (Meta:RedirectUriFacebook). The value provided here is the one Meta will redirect to after auth, and must match
      • Completes the Facebook connect flow with the short-lived token obtained from Meta.
    • Instagram
      • Starts the Instagram connect flow by generating a provider authorization URL. Optionally accepts a redirectUri to override the platform default (Meta:RedirectUriInstagram). The value provided here is the one Meta will redirect to after auth, and must matc
      • Dumps the server-side state of an Instagram channel (token introspection, Page→IG link, IG account, user permissions, app + page webhook subscriptions, and a raw conversations probe) plus inferred hints. Use this when sync returns 200 with empty data to s
      • Completes the Instagram connect flow with the short-lived token obtained from Meta.
    • Telegram
      • Creates or reconnects a Telegram channel and configures its webhook.
      • Partially updates Telegram channel configuration.
      • Disables a Telegram channel.
      • Creates or updates Telegram business connection metadata for a channel.
      • Lists Telegram business connections linked to a channel.
      • Returns Telegram webhook diagnostics for support and incident handling.
      • Returns Telegram channel status and webhook provisioning state.
  • Campaigns (v2)
    • Campaigns
      • Create campaign
      • Export campaigns
      • List campaigns (filtered/paged)
      • Get campaign details
      • Update campaign
    • Tools & Pricing
      • Calculate price before campaign creation
      • Get message metadata (length, GSM/Unicode, parts)
      • Parse CSV phone numbers
      • Get short-link domain
      • Calculate price for an existing campaign
      • Preview campaign recipients
    • Messages
      • Export campaign messages
      • List campaign messages
    • Telegram
      • Get Telegram verification status
      • Submit Telegram verification code
  • Contacts (v2)
    • Contacts
      • Create contact
      • Export contacts
      • Import contacts from CSV
      • List contacts (filtered/paged)
      • Get contact details
      • Update contact
      • Delete contact
    • Details
      • Create contact detail
      • Export contact details
      • List contact details (filtered)
      • Update contact detail
    • Messages
      • Export messages for contact
      • List messages for contact
  • Dashboard (v2)
    • Get channel breakdown statistics
    • Get dashboard KPIs
    • Get OTP-flow statistics
    • Get dashboard trend metrics
  • Segments (v2)
    • Create segment
    • Export segments
    • List segments (filtered/paged)
    • Get segment details
    • Update segment
    • Delete segment
    • Add contacts to segment
    • Remove contacts from segment
  • Schemas
    • V2CampaignTelegramVerificationStatusModel
    • TemplateFilteringSortingModel
    • SuccessResponseModelOfDidwwDidGroupDto
    • SocialChannelType
    • UserEmailConfirmCodeSendModel
    • V2ContactDetailType
    • CommunicationType
    • RateFilteringSortingModel
    • PagedListGetModelOfV2ContactGetModel
    • SuccessResponseModelOfPagedListGetModelOfRateGetModel
    • MarkConversationInProgressRequestDto
    • SuccessResponseModelOfV2ShortLinkDomainGetModel
    • PagedListGetModelOfNotificationGetModel
    • SenderIdFilteringSortingModel
    • SuccessResponseModelOfSipQueueSnapshotDto
    • V2CampaignChannelGetModel
    • DidSearchItemDto
    • SuccessResponseModelOfCannedResponseGetModel
    • V2CampaignExportRequestModel
    • WebhookSubscriptionStatusDto
    • SuccessResponseModelOfDidwwReservationDto
    • SuccessResponseModelOfPagedListGetModelOfSmsDataRecordGetModel
    • SocialProvider
    • UpsertTelegramBusinessConnectionRequestDto
    • SipPresenceSnapshotDto
    • SmsDataRecordGetModel
    • SuccessResponseModelOfPortSipQueueSnapshotDto
    • PbxTenantWebhookUpdateModel
    • V2CampaignChannelUpdateModel
    • ConnectFacebookRequestDto
    • SuccessResponseModelOfDidPurchaseResultDto
    • SuccessResponseModelOfSenderIdGetModel
    • V2SegmentUpdateModel
    • SuccessResponseModelOfListOfBusinessMemberGetModel
    • TelegramBusinessConnectionDto
    • V2ContactCsvDuplicateModel
    • SuccessResponseModelOfPortSipCallActionResultDto
    • PagedListGetModelOfRateGetModel
    • V2ContactMessageExportRequestModel
    • V2DashboardTrendsChannelModel
    • DataRecordFilterModel
    • SuccessResponseModelOfDidReservationDto
    • SyncConversationsResponseDto
    • SipTransferRequestDto
    • PortSipInternalCallRequestDto
    • InstagramDiagnosticsDto
    • UpdateTelegramChannelRequestDto
    • ReopenConversationRequestDto
    • CannedResponseUpdateModel
    • SuccessResponseModelOfSipCallActionResultDto
    • ProblemDetails
    • PaymentCreateModel
    • ClickEventDto
    • PagedListGetModelOfV2CampaignListItemModel
    • DidwwReservationsRequestDto
    • CustomerUserEmailRegisterModel
    • SuccessResponseModelOfNotificationListGetModel
    • PbxTenantFilteringSortingModel
    • UpdateWebhookSubscriptionRequest
    • SuccessResponseModelOfDidAssignmentCancelResultDto
    • SocialConnectionDto
    • NotificationListGetModel
    • ErrorResponseModel
    • UserPhoneNumberConfirmModel
    • V2ContactCreateModel
    • SuccessResponseModelOfPortSipVoicemailSummaryDto
    • SuccessResponseModelOfPagedListGetModelOfV2CampaignMessageListItemModel
    • UserTwoFactorSettingsGetModel
    • SuccessResponseModelOfV2CampaignCsvParseResultModel
    • V2SegmentContactsUpdateModel
    • TokenStatus
    • TelegramChannelStatusDto
    • SuccessResponseModelOfV2ContactCsvImportResultModel
    • DidPurchaseResultDto
    • SuccessResponseModelOfEmailPriceGetModel
    • CountryGetModel
    • CustomerUserGetModel
    • SuccessResponseModelOfSipPresenceSnapshotDto
    • PbxTenantGetModel
    • V2ContactCsvImportResultModel
    • V2ContactDetailCreateModel
    • SuccessResponseModelOfCountryGetModel
    • V2CampaignUpdateModel
    • SocialConversationDto
    • UnifiedInboxDto
    • ProviderType
    • AuthUrlResponseDto
    • CustomerUserLoginModel
    • SuccessResponseModelOfCustomerUserLoginResultModel
    • CreateWebhookSubscriptionRequest
    • WebhookSubscriptionResponse
    • SuccessResponseModelOfPagedListGetModelOfPbxCdrResponseModel
    • SuccessResponseModelOfV2CampaignGetModel
    • SuccessResponseModelOfPagedListGetModelOfSmsConversationGetModel
    • PagedListGetModelOfCurrencyGetModel
    • PortSipQueueSnapshotDto
    • V2ContactDetailUpdateModel
    • ConnectInstagramRequestDto
    • V2ContactUpdateModel
    • WhatsAppStatus
    • UserPasswordResetModel
    • PagedListGetModelOfPaymentGetModel
    • V2ContactDetailExportRequestModel
    • EmailDataRecordGetModel
    • SuccessResponseModelOfDidSearchItemDto
    • SmsConversationGetModel
    • UserEmailModel
    • DidReservationsRequestDto
    • SenderIdType
    • LinkAnalyticsResponse
    • SipVoicemailSummaryDto
    • CustomerUserLoginResultModel
    • V2ContactMessageListFilterModel
    • SuccessResponseModelOfPortSipSessionBootstrapResponseDto
    • FilterComparer
    • DidwwCountryDto
    • SuccessResponseModelOfV2SegmentGetModel
    • SipTeardownStatusDto
    • PagedListGetModelOfV2ContactDetailGetModel
    • PagedListGetModelOfV2CampaignMessageListItemModel
    • SenderIdGetModel
    • PaymentDirection
    • PortSipTransferRequestDto
    • TrafficType
    • UpdateLinkRequest
    • SuccessResponseModelOfPagedListGetModelOfV2CampaignListItemModel
    • DidwwCityDto
    • PaymentCreateResultGetModel
    • WhatsAppTemplateCategory
    • SuccessResponseModelOfDidComplianceRequirementsDto
    • PagedListGetModelOfSmsConversationGetModel
    • V2SegmentListFilterModel
    • V2CampaignMessageExportRequestModel
    • ConversationStatus
    • PbxCdrResponseModel
    • V2ExportMode
    • V2SegmentGetModel
    • DidwwOrderStatusDto
    • V2ContactDetailListFilterModel
    • SuccessResponseModelOfStatisticSenderIdExpensesGetModel
    • DidOrderStatusDto
    • V2ShortLinkDomainGetModel
    • SenderIdStatus
    • CustomerUserTwoFactorLoginModel
    • SuccessResponseModelOfSipVoicemailSummaryDto
    • PagedListGetModelOfV2ContactMessageListItemModel
    • SuccessResponseModelOfDidwwCountryDto
    • DidCityDto
    • SuccessResponseModelOfObject
    • SuccessResponseModelOfSmsDataRecordGetModel
    • CustomerUserRegisterModel
    • DidAssignmentResultDto
    • SipSessionBootstrapResponseDto
    • V2DashboardOtpStatsModel
    • SuccessResponseModelOfPagedListGetModelOfSenderIdGetModel
    • SuccessResponseModelOfStatisticBalanceGetModel
    • StatisticSenderIdExpensesGetModel
    • SocialMessageDto
    • TelegramWebhookDiagnosticDto
    • AdminUserGetModel
    • PagedListGetModelOfTemplateGetModel
    • SuccessResponseModelOfPagedListGetModelOfTemplateGetModel
    • V2CampaignPreCreationPriceModel
    • SuccessResponseModelOfPagedListGetModelOfCannedResponseGetModel
    • CreateLinkRequest
    • DidDidGroupDto
    • SuccessResponseModelOfPbxTenantGetModel
    • ProblemDetails_link
    • SenderIdTrafficTypeGetModel
    • SuccessResponseModelOfDidwwOrderStatusDto
    • V2CampaignListItemModel
    • BusinessMemberAcceptInvitationModel
    • SuccessResponseModelOfV2CampaignPricePreviewModel
    • UserPasswordUpdateModel
    • MessageStatus
    • SenderIdTypeGetModel
    • SocialChannelDto
    • DidSearchRequestDto
    • DidStockKeepingUnitDto
    • SipHoldResumeRequestDto
    • SuccessResponseModelOfPagedListGetModelOfAreaMccMncGetModel
    • SuccessResponseModelOfV2CampaignMessageInfoModel
    • TokenGetModel
    • PortSipSessionBootstrapResponseDto
    • PaymentType
    • V2CampaignChannelCreateModel
    • StatisticBalanceGetModel
    • V2CampaignPricePreviewModel
    • RateGetModel
    • SocialConversationStatusHistoryDto
    • SuccessResponseModelOfPaymentListGetModelOfPaymentGetModel
    • PaymentStatusUpdateModel
    • V2SegmentCreateModel
    • SuccessResponseModelOfBusinessMemberGetModel
    • SuccessResponseModelOfSipSessionBootstrapResponseDto
    • AreaMccMncFilterModel
    • CannedResponseGetModel
    • SuccessResponseModelOfString
    • PortSipPresenceSnapshotDto
    • MessageDirection
    • TokenRefreshModel
    • DidAssignmentHealthDto
    • PagedListGetModelOfEmailDataRecordGetModel
    • SocialProviderDto
    • PbxTenantCreateModel
    • SuccessResponseModelOfV2CampaignTelegramVerificationStatusModel
    • EmailPriceGetModel
    • ResyncChannelsResponseDto
    • SenderIdMediaAttachmentGetModel
    • TemplateUpdateModel
    • SuccessResponseModelOfPagedListGetModelOfV2SegmentGetModel
    • SipCallActionResultDto
    • CustomerUserSmsTwoFaLoginModel
    • PortSipVoicemailSummaryDto
    • SuccessResponseModelOfDidCityDto
    • IFormFile
    • DidwwComplianceRequirementsDto
    • SipMuteRequestDto
    • V2CampaignGetModel
    • PagedListGetModelOfSenderIdPriceGetModel
    • SuccessResponseModelOfDidCountryDto
    • SuccessResponseModelOfEmailDataRecordGetModel
    • PagedListGetModelOfV2SegmentGetModel
    • PartnerCustomerUserLoginModel
    • CreateTelegramChannelRequestDto
    • V2ContactExportRequestModel
    • DidwwReservationDto
    • SuccessResponseModelOfTokenGetModel
    • PaginationModel
    • SyncMessagesResponseDto
    • SuccessResponseModelOfIEnumerableOfLong
    • SuccessResponseModelOfPaymentGetModel
    • SortingModel
    • V2CampaignChannelSummaryModel
    • SenderIdPriceGetModel
    • DidwwStockKeepingUnitDto
    • SuccessResponseModelOfIReadOnlyCollectionOfDidAssignmentHealthDto
    • V2SegmentExportRequestModel
    • AssignConversationRequestDto
    • DidwwDidGroupDto
    • CurrencyGetModel
    • JsonElement
    • V2DashboardKpisModel
    • DidComplianceRequirementsDto
    • SuccessResponseModelOfTemplateGetModel
    • SuccessResponseModelOfDidAssignmentResultDto
    • DidAssignmentUpdateDto
    • V2CampaignMessageInfoModel
    • CustomerUserCompanyUpdateModel
    • AreaMccMncGetModel
    • UserPhoneNumberConfirmCodeSendModel
    • V2DashboardOtpChannelModel
    • CampaignAnalyticsListRequest
    • DidAssignmentScopeUpdateDto
    • PortSipMuteRequestDto
    • PaymentListGetModelOfPaymentGetModel
    • V2CampaignCsvParseResultModel
    • V2CampaignTelegramVerifyCodeModel
    • ReplyMessageResponseDto
    • SipStartCallRequestDto
    • NotificationGetModel
    • SuccessResponseModelOfPaymentCreateResultGetModel
    • V2ContactDetailGetModel
    • UserEmailConfirmModel
    • V2DashboardChannelBreakdownModel
    • CustomerUserUpdateModel
    • DidReservationDto
    • SuccessResponseModelOfDidwwComplianceRequirementsDto
    • SuccessResponseModelOfPagedListGetModelOfCurrencyGetModel
    • DiagnosticProbeDto
    • ContactAnalyticsResponse
    • SuccessResponseModelOfLong
    • BusinessMemberGetModel
    • PortSipTeardownStatusDto
    • LinkResponse
    • SuccessResponseModelOfCustomerUserGetModel
    • V2ContactGetModel
    • SuccessResponseModelOfBoolean
    • V2ContactDetailStatus
    • SuccessResponseModelOfPagedListGetModelOfSenderIdPriceGetModel
    • V2CampaignChannelPricePreviewModel
    • PagedListGetModelOfPbxTenantGetModel
    • PagedListGetModelOfCannedResponseGetModel
    • SuccessResponseModelOfUserTwoFactorSettingsGetModel
    • PagedListGetModelOfSenderIdGetModel
    • SipInternalCallRequestDto
    • V2DashboardTrendsDataPointModel
    • TemplateGetBaseModel
    • SenderIdViberLogoGetModel
    • CloseConversationRequestDto
    • PortSipCallActionResultDto
    • UserPhoneNumberModel
    • V2DashboardChannelFunnelModel
    • ResolveConversationRequestDto
    • TemplateGetModel
    • ConversationStatusHistoryActionType
    • PagedListGetModelOfPbxCdrResponseModel
    • PagedListGetModelOfSmsDataRecordGetModel
    • PaymentGetModel
    • SuccessResponseModelOfDidAssignmentResponseDto
    • PbxTenantWebhookGetModel
    • V2CampaignListFilterModel
    • BusinessMemberUpdateSenderAssignmentsModel
    • SuccessResponseModelOfPbxTenantWebhookGetModel
    • CustomerTrunkBaseGetModel
    • V2CampaignMessageListFilterModel
    • DidAssignmentRequestDto
    • SuccessResponseModelOfDidPermissionsDto
    • DidPurchaseRequestDto
    • CampaignAnalyticsResponse
    • V2CampaignCreateModel
    • BusinessType
    • PaymentFilterModel
    • PortSipStartCallRequestDto
    • V2CampaignMessageInfoRequest
    • TemplateMediaAttachmentGetModel
    • SuccessResponseModelOfPortSipPresenceSnapshotDto
    • DidPermissionsDto
    • UserTwoFactorSettingsUpdateModel
    • SuccessResponseModelOfV2CampaignRecipientPreviewModel
    • PortSipHoldResumeRequestDto
    • FilteringModel
    • MessageType
    • SipQueueSnapshotDto
    • SuccessResponseModelOfPagedListGetModelOfV2ContactMessageListItemModel
    • TemplateStatus
    • SuccessResponseModelOfCustomerTrunkBaseGetModel
    • CannedResponseCreateModel
    • FilteringSortingModel
    • DidCountryDto
    • SuccessResponseModelOfDidProvisioningResultDto
    • SuccessResponseModelOfDidwwCityDto
    • V2ContactListFilterModel
    • V2CampaignMessageListItemModel
    • TwoFactorMethod
    • V2DashboardTrendsModel
    • ComplianceRequestCreateDto
    • V2ContactMessageListItemModel
    • SuccessResponseModelOfDidOrderStatusDto
    • WebhookDeliveryResponse
    • BusinessMemberAssignSenderIdModel
    • ConversationFilteringSortingModel
    • DidProvisioningResultDto
    • SuccessResponseModelOfDidDidGroupDto
    • SuccessResponseModelOfPagedListGetModelOfPbxTenantGetModel
    • UserPhoneNumberUpdateModel
    • SuccessResponseModelOfPagedListGetModelOfEmailDataRecordGetModel
    • V2CampaignRecipientPreviewModel
    • SuccessResponseModelOfV2ContactGetModel
    • SuccessResponseModelOfPagedListGetModelOfV2ContactDetailGetModel
    • DidAssignmentCancelResultDto
    • SortDirection
    • UserEmailUpdateModel
    • Solution
    • PagedListGetModelOfAreaMccMncGetModel
    • BusinessMemberSenderIdGetModel
    • V2CampaignUnresolvableRecipientModel
    • RateDetailGetModel
    • BusinessMemberCreateModel
    • RefreshTokenResponseDto
    • SuccessResponseModelOfPagedListGetModelOfV2ContactGetModel
    • DidAssignmentResponseDto
  1. Session

Initialise WebRTC/SIP session

POST
https://api.veloconnect.me/api/sip/voice/session/bootstrap
Telephony
Last modified:2026-06-01 19:28:25
Initialise WebRTC/SIP session.
Authentication: Requires JWT bearer token.
Success response (200): SuccessResponseModelOfSipSessionBootstrapResponseDto

Request

Authorization
or

Responses

🟢200OK
application/json
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.veloconnect.me/api/sip/voice/session/bootstrap'
Response Response Example
200 - Success Example
{
    "data": [
        {
            "username": "string",
            "password": "string",
            "domain": "string",
            "server": "string",
            "displayName": "string",
            "extension": "string",
            "sessionToken": "string",
            "expiresAtUtc": "2025-01-01T00:00:00Z"
        }
    ]
}
Modified at 2026-06-01 19:28:25
Previous
Unmute call audio
Next
Exports email data records to a CSV file
Built with