Methods List
BYTEHAND REST API methods.
OAuth
A group of methods designed to work with OAuth authorization, both with external providers, and with an internal BYTEHAND provider.
| Method | Description |
|---|---|
| authorizeWithInnerOAuth | GET /oauth/authorize Opens an OAuth authorization dialog. |
| bindWithExternalOAuth | PATCH /oauth/providers/providerId Binds a BYTEHAND user and an account in an external OAuth service. |
| exchangeInnnerOAuthCode | POST /oauth/token Exchanges an OAuth authorization access code for an access token. |
| getExternalOAuthProviders | GET /oauth/providers Returns a list of providers for authorization through external OAuth services. |
| loginWithExternalOAuth | PUT /oauth/providers/providerId Authorizes a BYTEHAND user through an external OAuth service. |
| registerWithExternalOAuth | POST /oauth/providers/providerId Registers a new BYTEHAND user via an external OAuth service. |
| revokeInnnerOAuthToken | DELETE /oauth/token Revokes the current access token obtained via OAuth authorization. |
Users
Group of methods for working with BYTEHAND users.
| Method | Description |
|---|---|
| createCurrentUserCredential | POST /users/current/credentials Creates a new access key. |
| deleteCurrentUserAccount | DELETE /users/current/oauth/userAccountId Unlinks an account in an external OAuth service from a BYTEHAND user. |
| deleteCurrentUserCredential | DELETE /users/current/credentials/credentialId Deletes an access key by its ID. |
| getCurrentUserAccounts | GET /users/current/oauth Returns a list of all associated accounts in external OAuth services. |
| getCurrentUserBillingPlan | GET /users/current/billing_plan Returns information about the user's billing plan. |
| getCurrentUserContract | GET /users/current/contract Returns information about the contract. |
| getCurrentUserCredentialById | GET /users/current/credentials/credentialId Returns access key information by ID. |
| getCurrentUserCredentialGeo | GET /users/current/credentials/credentialId/geo Returns geographic information about the creator of an access key by ID. |
| getCurrentUserCredentials | GET /users/current/credentials Returns access key information. |
| getCurrentUserStatistics | GET /users/current/statistics Returns activity statistics for the last 90 days. |
| getCurrentUserThisCredential | GET /users/current/credentials/this Returns information about the current access key. |
| getCurrentUser | GET /users/current Returns information about the user. |
| getUsersTimeZoneById | GET /users/time_zones/timeZoneId Returns the time zone with the given ID. |
| getUsersTimeZones | GET /users/time_zones Returns a list of all time zones used in BYTEHAND. |
| initiateCurrentUserContract | POST /users/current/contract Initiates the procedure for signing a user contract with BYTEHAND. |
| loginUser | PUT /users Authorizes a user with a login and password. |
| registerUser | POST /users Creates a new BYTEHAND account. |
| resetCurrentUserApiKeyV1 | POST /users/current/api_key_v1 Regenerates the BYTEHAND API v1 access key. |
| resetCurrentUserSmppPassword | POST /users/current/smpp_password Resets the password for the SMPP connection. |
| resetUserPasswordComplete | PATCH /users/password Completes the user password reset procedure. |
| resetUserPassword | POST /users/password Starts the user password reset procedure. |
| setCurrentUserRouting | PATCH /users/current/routing Sets the routing policy to restrict the sending of SMS messages. |
| updateCurrentUserContract | PATCH /users/current/contract Edits the valid fields in the contract. |
| updateCurrentUserEmail | PATCH /users/current/email Starts the procedure for changing the email address. |
| updateCurrentUserPassword | PATCH /users/current/password Changes the user's password. |
| updateCurrentUser | PATCH /users/current Updates user information. |
SMS Messages
A group of methods for sending, viewing, editing and deleting SMS messages.
| Method | Description |
|---|---|
| deleteSmsById | DELETE /sms/messages/smsId Deletes an SMS message by its ID. |
| deleteSms | DELETE /sms/messages Deletes SMS messages. |
| getSmsById | GET /sms/messages/smsId Returns an SMS message by its ID. |
| getSmsProbe | GET /sms/messages/probe Gets information about the phone number and text of the SMS message. |
| querySmsCount | HEAD /sms/messages Returns the number of SMS messages that match the query. |
| querySms | GET /sms/messages Returns SMS messages that match the query. |
| sendSms | POST /sms/messages Sends one or more SMS messages. |
| updateSmsById | PATCH /sms/messages/smsId Stops or starts sending an SMS message by its ID. |
| updateSms | PATCH /sms/messages Stops or starts sending SMS messages. |
SMS Campaigns
A group of methods for working with SMS campaigns.
| Method | Description |
|---|---|
| deleteSmsCampaignById | DELETE /sms/campaigns/smsCampaignId Deletes an SMS campaign by its ID. |
| deleteSmsCampaigns | DELETE /sms/campaigns Deletes SMS Campaigns. |
| getSmsCampaignById | GET /sms/campaigns/smsCampaignId Returns SMS CampaignById. |
| getSmsCampaignCountries | GET /sms/campaigns/smsCampaignId/countries Returns country statistics for SMS campaigns by its ID. |
| getSmsCampaignParts | GET /sms/campaigns/smsCampaignId/parts Returns statistics on the number of message parts for SMS campaigns by its ID. |
| getSmsCampaignStates | GET /sms/campaigns/smsCampaignId/errors Returns statistics on message statuses and errors for SMS campaigns by its ID. |
| querySmsCampaignCount | HEAD /sms/campaigns Returns the number of SMS messages matching the query. |
| querySmsCampaigns | GET /sms/campaigns Returns SMS campaigns that match the query. |
| sendSmsCampaign | POST /sms/campaigns Sends Campaign SMS |
| updateSmsCampaignById | PATCH /sms/campaigns/smsCampaignId Stops or starts sending SMS campaigns by campaign ID. |
| updateSmsCampaigns | PATCH /sms/campaigns Stops or starts sending SMS campaigns. |
SMS Senders
A group of methods for creating and removing SMS senders.
| Method | Description |
|---|---|
| deleteSmsSenderById | DELETE /sms/senders/smsSenderId Deletes the signature of an SMS sender by its ID. |
| deleteSmsSenders | DELETE /sms/senders Deletes signatures of SMS senders. |
| getSmsSenderById | GET /sms/senders/smsSenderId Returns the SMS sender's signature by ID. |
| putSmsSender | PUT /sms/senders Creates or changes the signature of an SMS sender. |
| querySmsSendersCount | HEAD /sms/senders Returns the number of signatures of SMS senders that match the query. |
| querySmsSenders | GET /sms/senders Returns the signatures of SMS senders that match the query. |
SMS Templates
A group of methods for working with SMS templates.
| Method | Description |
|---|---|
| createSmsTemplate | POST /sms/templates Creates an SMS template. |
| deleteSmsTemplateById | DELETE /sms/templates/smsTemplateId Deletes an SMS template by its ID. |
| deleteSmsTemplates | DELETE /sms/templates Deletes SMS message templates. |
| getSmsTemplateById | GET /sms/templates/smsTemplateId Returns the SMS template by its ID. |
| querySmsTemplateCategories | GET /sms/templates/categories Returns SMS template categories. |
| querySmsTemplatesCount | HEAD /sms/templates Returns the number of SMS templates that match the query. |
| querySmsTemplates | GET /sms/templates Returns SMS templates that match the query. |
| updateSmsTemplateById | PATCH /sms/templates/smsTemplateId Edits an SMS template by its ID. |
Contacts
A group of methods for working with the address book and contacts.
| Method | Description |
|---|---|
| createContactListContacts | POST /contact_lists/listId/contacts Creates one or more contacts in the contact list. |
| createContactListProperty | POST /contact_lists/listId/properties Creates an additional field for the contact list. |
| createContactListSegment | POST /contact_lists/listId/segments Creates a new segment for the contact list. |
| createContactList | POST /contact_lists Creates a contact list. |
| deleteContactListById | DELETE /contact_lists/listId Deletes a contact list by its ID. |
| deleteContactListContactById | DELETE /contact_lists/listId/contacts/contactId Deletes a contact in the contact list by its ID. |
| deleteContactListContacts | DELETE /contact_lists/listId/contacts Deletes contacts in the contact list. |
| deleteContactListPropertyById | DELETE /contact_lists/listId/properties/propertyId Deletes a field from the contact list by its ID. |
| deleteContactListSegmentById | DELETE /contact_lists/listId/segments/segmentId Deletes a segment from the contact list by its ID. |
| deleteContactLists | DELETE /contact_lists Deletes contact lists. |
| deleteContactListsV1 | DELETE /contact_lists/v1 Deletes contact lists in legacy format. |
| deleteContactListV1ById | DELETE /contact_lists/v1/listId Deletes a legacy contact list by ID. |
| getContactListById | GET /contact_lists/listId Returns a contact list by its ID. |
| getContactListContactById | GET /contact_lists/listId/contacts/contactId Returns a contact in the contact list by its ID. |
| getContactListProperties | GET /contact_lists/listId/properties Returns the fields in the contact list. |
| getContactListPropertyById | GET /contact_lists/listId/properties/propertyId Returns a field in the contact list by its ID. |
| getContactListSegmentById | GET /contact_lists/listId/segments/segmentId Returns a segment in the contact list by its ID. |
| getContactListSegments | GET /contact_lists/listId/segments Returns the segments in the contact list. |
| getContactListV1ById | GET /contact_lists/v1/listId Returns contact lists in legacy format. |
| queryContactListContactsCount | HEAD /contact_lists/listId/contacts Returns the number of contacts from the contact list that match the query. |
| queryContactListContacts | GET /contact_lists/listId/contacts Returns the contacts and contact list that match the query. |
| queryContactListsCount | HEAD /contact_lists Returns the number of contact lists that match the query. |
| queryContactListsCountV1 | HEAD /contact_lists/v1 Returns the number of legacy contact lists that match the query. |
| queryContactLists | GET /contact_lists Returns lists of contacts that match the query. |
| queryContactListsV1 | GET /contact_lists/v1 Returns legacy contact lists that match the query. |
| updateContactListContactById | PATCH /contact_lists/listId/contacts/contactId Edits a contact in the contact list by its ID. |
| updateContactListContacts | PATCH /contact_lists/listId/contacts Edits contacts in the contact list. |
| updateContactListPropertyById | PATCH /contact_lists/listId/properties/propertyId Edits the contact list field by its ID. |
| updateContactListSegmentById | PATCH /contact_lists/listId/segments/segmentId Edits a contact list segment by its ID. |
| updateContactList | PATCH /contact_lists/listId Edits the contact list. |
| upgradeContactListV1ById | POST /contact_lists/v1/listId Upgrades a contact list from a legacy format by its ID to the current format. |
History
A group of methods for obtaining information about previously performed actions.
| Method | Description |
|---|---|
| queryHistory | GET /history Returns the history of sending SMS messages by phone number. |
Payments
Group of methods for working with payments, invoices and transactions.
| Method | Description |
|---|---|
| activateBonus | POST /payments/bonuses Activates the promo code. |
| activateStartupBonus | POST /payments/bonuses/startup Activates the initial bonus for testing the service. |
| createDepositRequest | POST /payments/deposits Starts a deposit operation. |
| createInvoice | POST /payments/invoices Creates an invoice for payment via bank transfer. |
| createPayback | POST /payments/paybacks Creates a withdrawal request. |
| createRecurringPayment | POST /payments/recurring Starts auto payment connection. |
| deleteInvoice | DELETE /payments/invoices/invoiceId Deletes an invoice. |
| deleteRecurringPayment | DELETE /payments/recurring Deletes an enabled auto payment. |
| getInvoiceById | GET /payments/invoices/invoiceId Returns an invoice by its ID. |
| getInvoices | GET /payments/invoices Returns invoices. |
| getPossibleDepositRequests | GET /payments/deposits Returns available payment options. |
| getProvidedServicesActs | GET /payments/acts Returns information for printing acts of services provided. |
| getReferralById | GET /payments/referrals/referralId Returns the referral user by their ID. |
| getReferralStatisticsById | GET /payments/referrals/referralId/statistics Returns statistics for a referral user by their ID. |
| queryReferralCount | HEAD /payments/referrals Returns the number of referral users that matched the query. |
| queryReferrals | GET /payments/referrals Returns referral users that match the query. |
| queryTransactionCount | HEAD /payments/transactions/group Returns the number of transactions that matched the query. |
| queryTransactions | GET /payments/transactions/group Returns transactions that match the query. |
Billing Plans
A group of methods for obtaining information on billing plans.
| Method | Description |
|---|---|
| getBillingPlans | GET /billing_plans Returns billing plans. |
News
A group of methods for receiving BYTEHAND news.
| Method | Description |
|---|---|
| getNewsById | GET /news/newsId Returns a news item by its ID. |
| queryNewsCount | HEAD /news Returns the number of news items matching the query. |
| queryNews | GET /news Returns the news that matches the query. |
Applications
Group of methods for working with BYTEHAND applications.
| Method | Description |
|---|---|
| getApplicationById | GET /applications/applicationId Retrieves the application by unique ID. |
| queryApplicationsCount | HEAD /applications Returns the number of applications matching the query. |
| queryApplications | GET /applications Returns BYTEHAND applications that match the query. |
Other
A group of helper methods.
| Method | Description |
|---|---|
| getCompaniesSuggestions | GET /companies/suggestions Returns information about legal entities for Russia. |
| getLegalEntities | GET /legal_entities Returns a list of legal entities with which it is possible to sign a contract. |
| querySmsRouteIntervalsCount | HEAD /sms/routes/intervals Returns the number of route intervals for SMS messages that match the query. |
| querySmsRouteIntervals | GET /sms/routes/intervals Returns the route intervals for SMS messages that match the query. |
| querySmsRoutesCount | HEAD /sms/routes Returns the number of routes for SMS messages that match the query. |
| querySmsRoutes | GET /sms/routes Returns the routes for SMS messages that match the query. |
| sendSupportTicket | POST /support Sends a message to BYTEHAND support. |