Welcome to the Resont developer
These documentoin have been collected for your ease of use of the features and facilities of resont, as well as to develop and complete your products using the platforms created by resont.
If you have any questions, contact the technical team of Resont in the support tickets section so that the technical colleagues will answer your questions as soon as possible.
Start
Please keep these things in mind before starting work:
- Resont webservice is written in
REST
. - To receive the
Token
, refer to the token authentication section. -
If you need
OAuth2
, be sure to fill out the form on This page so that we can contact you and make the necessary arrangements. - If you have any questions, contact the technical team of Resont in the support tickets section so that the technical colleagues will answer your questions as soon as possible.
All Navinhub Webservices require an authentication section. Please complete the authentication process before use.
API Detail
When using Resont API, you must specify the desired version in the request link. The version with suffix v
and its number is sent in the link. For example, if you intend to use version 1, the value v1
is sent in the request link.
The api link based on authentication methods is as follows
token
if using a token, the request link ishttps://api.resont.com/token/v{version}
.Currently, the latest version isv1
and its link ishttps://api.resont.com/token/v1
OAuth
If using OAuth, the request link ishttps://api.resont.com/v{version}
Currently, the latest version isv1
and its link ishttps://api.resont.com/v1
Field expansion
You can use the Field expansion feature for convenience and merging multiple requests.
The value of this file must be sent with the name with
in the request. You can enter several fields in the request. These values must be separated from each other with Comma(,)
You can also use this value nested, in which case it should be sent in parent(child,...)
format.
For example, in the Comment section, you can use the fields mentioned on the page. In this example, the sample value of with
is like with=account,socialUser,accountPost
.
In the example above, you can also send the meta value, which is a Field expansion in the Account section, like with=account(meta),socialUser,accountPost
.
File upload
Uploading to Webservices that require file uploading should be sent as multipart/form-data
.
Pagination
If there is a large number of outputs in a Webservice, the output is sent as pagination.
This output is in the form of a Paginate object, which contains 2 data
fields containing requested and paging
information with the following specifications.
total
: total number of itemspage
: current page numbertotalPage
: total page numbernext
: next page addressprev
: previous page address
You can send your desired page
number in the desired request with page input. Or calculate the link of next and previous pages with the help of prev and next fields.
Cursor pagination
If there is a large number of outputs in a Webservice, the output is sent as pagination with reference.
The main difference of this pagination is the absence of page numbers. In this pagination, depending on the type of Webservice in the request, it is determined whether the data should be sent before or after.
This output is in the form of a CursorPagination object that contains 2 data
fields containing requested information and paging
with the following specifications.
total
: total number of itemsafter
: next page addressbefore
: last page address
You can send your desired page number in the desired request with after
or before
entry.
Or calculate the link of the next and previous pages with the help of the after and before fields.
Be careful, in the requests that include before
, the data may be more than the allowed number. The data is sent from the beginning and the rest of the data is received with the help of the after
field. In this case, both after
and before
fields are sent.
Errors
Resont Webservice is sen`t in the form of an array with error
index in various error requests, whose format is ErrorResponse.
trace_id
value along with the desired problem to the technical support of Resont.
Also, in case of an error, the value of http status is sent in the form of the following table.
Error number | type | Description |
---|---|---|
400 | ValidationException | Error validating the request |
401 | HttpException | The access_token sent has expired. |
403 | HttpException | Unable to access the desired page. |
404 | HttpException | The requested page could not be found. |
429 | HttpException | The api usage limit for this device has expired. |
500 | HttpException | Internal server error. |
Authentication
Authentication in Resont is in two forms: token and OAuth2.
In token mode, you can get your token simply by visiting the user panel.
In OAuth2 mode, it is necessary to send a request and receive it after the necessary coordination.
To receive OAuth2, please complete this form.
Token
If you need authentication through a token, you must send the token value in the form of a query string
with the name token
in the requests.
If you have a personal application or website and you intend to use Resont services for yourself to receive tokens, please click here.
The request link with the help of token is https://api.resont.com/token/v1/account
. For example, to receive accounts, the requested link is as follows:
https://api.resont.com/token/v1/account?token={token}
OAuth
The authentication process is based on oAuth2
, you need client_id
and
client_secret
to use Resont service.
The following definitions can help you better understand the concepts.
- User: A person who has an account on the Novin Hub site.
- Service: a website or application that intends to use Novin Hub's api.
- Client id: It is the ID of the user's service, which is created when the service is created in the Resont.
- Client secret: It is a secret key that is created when the service is created in the Resont.
- Access token: Token received from user authentication and verification. Currently, the life of this token is one month.
- Scope: Access required by the service in the user's account, which is separated by a space character.
- Refresh token: token to receive a new access token. Currently, the life of this token is 1 year.
- Redirect uri: the link back to the source service (the link can be sent as a url or as a deep link)
- Authorization code: the code received when returning from the link to receive the access token
All requests should be sent to https://api.resont.com/web/
. For example, to create a token, redirect
the user to https:/api.resont.com/web/oauth/authorize
.
Send user to Resont
To get a new token, direct the user to the following path.
Webservice address
auth_oauth
Name | Type | Description |
---|---|---|
client_id | Mandatory | Client id |
response_type | Mandatory | Amounts: code : if you have client_secret. token : if your service is implemented on the user side and it is not possible to store the client_secret. For example, your site is based on javascript under the browser. Pay attention, in this method refresh_token is not sent in the output. |
scope | Mandatory | Scope |
state | Mandatory | The csrf token generated by the service. |
redirect_uri | Optional | The return link will be placed if the default value is not entered. The link must include the default value. |
After authentication and access confirmation by the user, the user will be sent to the redirect_url link. And the following values are sent as GET.
If the value of response_type is equal to code:
Name | Type | Description |
---|---|---|
code | Optional | The authorization_code value to be used in the next request. The life of this code is 30 seconds. |
state | Optional | csrf token sent from the service |
If the value of response_type is equal to token.
Name | Type | Description |
---|---|---|
state | Optional | Csrf token sent from the service |
access_token | Optional | Webservice connection token |
expires_in | Optional | Token validity in seconds |
token_type | Optional | Constant value: access_token |
scope | Optional | Access list |
Receive access token
If you set the value of response_type to code when directing the user to the Resont, you need to send the code received in the return link to the following path to receive the access_token.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
client_id | Mandatory | Client id |
client_secret | Mandatory | Client secret |
grant_type | Mandatory | Constant value: authorization_code |
code | Mandatory | The code received in the return link |
redirect_uri | Mandatory | The return link, if not entered in the initial request, the default value should be sent. |
Request output:
Name | Type | Description |
---|---|---|
access_token | - | Client id |
expires_in | - | Client secret |
token_type | - | Constant value: authorization_code |
scope | - | The code received in the return link |
refresh_token | - | The return link, if not entered in the initial request, the default value should be sent. |
refresh_token_expires | - | Token expiration date |
Receive a new token with Refresh token
If the access token has expired or you need a new token, get a new token by sending entries to the link below.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
client_id | Mandatory | Client id |
client_secret | Mandatory | Client secret |
grant_type | Mandatory | Constant value: refresh_token |
refresh_token | Mandatory | Refresh token value |
Request output:
Name | Type | Description |
---|---|---|
access_token | - | Webservice connection token |
expires_in | - | Token validity in seconds |
token_type | - | Constant value: access_token |
scope | - | Access list |
New request with received token
After receiving the access token, you can use the Novin Hub web service, whose documentation is in the developers. In the sent requests, send the token value with the name access_token in the request link as query params.
Webservice address:
For example
https://api.resont.com/v1/account?access_token={token}
List of available scopes:
- basic
- mobile
- offline_access
- implicit_approve
- account
- post
- publish
- insights
- comment
- inbox
The authentication process is based on oAuth2 and you need client_id
and client_secret
to
use it.
The following definitions can help you better understand the concepts.
- User: A person who has an account on Novin Hub site.
- Service: a website or application that intends to use Novin Hub's api.
- Client id: It is the ID of the user's service, which is created when the service is created in the Resont.
- Client secret: It is a secret key that is created when the service is created in the Resont.
- Access token: Token received from user authentication and verification. Currently, the life of this token is one month.
- Scope: Access required by the service in the user's account, which is separated by a space character.
- Refresh token: token to receive a new access token. Currently, the life of this token is 1 year.
- Redirect uri: the link back to the source service (the link can be sent as a url or as a deep link)
- Authorization code: the code received when returning from the link to receive the access token
All requests should be sent to https://api.resont.com/web/
. For example, to create a token, redirect the user to https:/api.resont.com/web/oauth/authorize
.
Send user to Resont
To get a new token, direct the user to the following path.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
client_id | Mandatory | Client id |
response_type | Mandatory | Values: code: if you have client_secret. token: if your service is implemented on the user side and it is not possible to store the client_secret. For example, your site is based on javascript under the browser. Pay attention, in this method refresh_token is not sent in the output. |
scope | Mandatory | Scope |
state | Mandatory | The csrf token generated by the service. |
redirect_uri | Optional | The return link will be placed if the default value is not entered. The link must include the default value. |
After authentication and access confirmation by the user, the user will be sent to the redirect_url link. And the following values are sent as get.
If the value of response_type is equal to code.
Name | Type | Description |
---|---|---|
code | Optional | The authorization_code value to be used in the next request. The life of this code is 30 seconds. |
state | Optional | csrf token sent from the service |
If the value of response_type is equal to token.
Name | Type | Description |
---|---|---|
state | Optional | csrf token sent from the service |
access_token | Optional | Web service connection token |
expires_in | Optional | Token validity in seconds |
token_type | Optional | Constant value: access_token |
scope | Optional | Access list |
Receive access token
If you set the value of response_type to code when directing the user to the Resont, you need to send the code received in the return link to the following path to receive the access_token.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
client_id | Mandatory | Client id |
client_secret | Mandatory | Client secret |
grant_type | Mandatory | Constant value: authorization_code |
code | Mandatory | The code received in the return link. |
redirect_uri | Mandatory | The return link, if not entered in the initial request, the default value should be sent. |
Request output:
Name | Type | Description |
---|---|---|
access_token | - | Client id |
expires_in | - | Client secret |
token_type | - | Constant value: authorization_code |
scope | - | The code received in the return link. |
refresh_token | - | The return link, if not entered in the initial request, the default value should be sent. |
refresh_token_expires | - | The return link, if not entered in the initial request, the default value should be sent. |
Receive a new token with Refresh token
If the access token has expired or you need a new token, get a new token by sending entries to the link below.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
client_id | Mandatory | Client id |
client_secret | Mandatory | Client secret |
grant_type | Mandatory | Constant value: refresh_token. |
refresh_token | Mandatory | Refresh token value. |
Request output:
Name | Type | Description |
---|---|---|
access_token | - | Webservice connection token. |
expires_in | - | Token validity in seconds. |
token_type | - | Constant value: access_token. |
scope | - | Access list. |
New request with received token
After receiving the access token, you can use the Novin Hub web service, whose documentation is in the link https://resont.com/developers. In the sent requests, send the token value with the name access_token in the request link as query params.
Webservice link:
for example
https://api.resont.com/v1/account?access_token={token}
Apply OAuth
In Resont, two types of tokens are placed in the API, and the user token is always available in the profile settings section.
We need to coordinate with you for the OAuth token, and for this purpose, please complete the form below so that we can contact you as soon as possible.
webhook
Webhook is one of the methods by which web applications can communicate with each other. Using webhooks, third-party APIs can be used in the application development project. Webhooks make it possible to send real-time data from one application to another whenever an event occurs.
If you need to receive events during changes in the Resont, you can use webhook.
The data sent in json format is sent to the webhook_url link that was registered when the client_id was registered.
Receive Changes
To receive changes via webhook, there must be a valid Refresh token with offline_access access.
The structure of the sent value is as follows:
{
‘type’ => ‘Type of change occurred’,
‘user_id’ => ‘User ID’,
‘payload’ => ‘Content of change’
}
- message_created type Occurs when a new (direct) message is registered in the user's account.
- comment_created type Occurs when a new comment is registered in the user's account
payload value:
https://resont.com/developers#reference-Message
https://resont.com/developers#reference-Comment
Accounts
With the help of this service, you can manage different social media accounts.
Accounts List
With the help of this service, you can get the list of all the desired user accounts.
Webservice address
Parameters
No Input
Output
The array of Account is sent in the output.
You can also receive the following values with the help of Field expansion by sending a parameter with
with a value meta based on social networks.
Telegram
Name | Type | Description |
---|---|---|
botusername | string | Custom bot username. |
botapikey | string | Dedicated bot api key. |
Create Account
You can add a new account with the help of this service.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
type | string | Type of social network account |
redirect | string | Return link if the user is directed to the social network |
Also, for social networks in the list below, separate entries are required, which are mentioned in each section.
Aparat Parameters
Name | Type | Description |
---|---|---|
username | string | Username |
password | string | password |
Bale Parameters
Name | Type | Description |
---|---|---|
username | string | Network channel name |
botusername | string | (Optional) Custom bot username |
botapikey | string | (Optional) Custom bot api key |
Eitaa parameters
Name | Type | Description |
---|---|---|
username | string | Network channel name |
token | string | Network channel token |
Gap parameters
Name | Type | Description |
---|---|---|
username | string | Network channel name |
botusername | string | (Optional) Custom bot username |
botapikey | string | (Optional) Custom bot api key |
Instagram parameters
Name | Type | Description |
---|---|---|
username | string | Network username |
password | string | Network password |
Soroush parameters
Name | Type | Description |
---|---|---|
username | string | Network channel name |
botapikey | string | (Optional) Custom bot api key |
Telegram parameters
Name | Type | Description |
---|---|---|
username | string | Network channel name |
botusername | string | (Optional) Custom bot username |
botapikey | string | (Optional) Custom bot api key |
output
The created Account object is sent to the output
Or if the user needs to be redirected to the social network to get access, the RedirectResponse object is sent in the output.
Account detail
With the help of this service, you can accountId
get account details with ID.
Webservice address
:accountId
Parameters
No Input
output
The Account object is sent in the output.
Edit account
With the help of this service, you can accountId
edit the account with ID.
Webservice address
:accountId
Parameters
Name | Type | Description |
---|---|---|
type | string | Type of social network account |
redirect | string | Return link if the user is directed to the social network |
Also, for social networks in This list , separate entries are required, which are mentioned in each section.
output
The created Account object is sent to the output
Or if the user needs to be redirected to the social network to get access, the RedirectResponse object is sent in the output.
Delete account
With the help of this service, you can delete the account with ID accountId
.
Webservice address
:accountId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
Account groups
With the help of this service, you can group your social network accounts and place them in different groups. This grouping is used for faster selection when publishing content.
Account groups list
With the help of this service, you can get the list of all the desired user account groups.
Webservice address
Parameters
No Input
Output
The array of AccountGroup is passed in the output.
Create account group
With the help of this service, you can add a new account group.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
name | string | Group name |
account_ids | integer[] | User IDs |
Output
The created AccountGroup object is sent to the output.
Account group detail
With the help of this service, you can get the details of the account group with ID accountGroupId
.
Webservice address
:accountGroupId
Parameters
No Input
Output
The AccountGroup object is passed in the output.
Edit Account group
With the help of this service, you can accountGroupId
edit the account group with ID.
Webservice address
:accountGroupId
Parameters
Name | Type | Description |
---|---|---|
name | string | Group name |
account_ids | integer[] | User IDs |
Output
The edited AccountGroup object is sent to the output.
delete account group
With the help of this service, you can delete the account group with ID accountGroupId
.
Webservice address
:accountGroupId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
Comments
With the help of this service, you can manage the comments received on social networks in a dashboard.
All features of viewing, responding and deleting are available, and Resont also provides you with more features such as creating tags and categories, receiving output files, etc.
Comments list
With the help of this service, you can get the list of comments of the desired user.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
tag | integer[] | (Optional) Comment tag ids filter |
status | string | (Optional) Comment status filter |
date_from | string | (Optional) Filter comment after a date |
date_to | string | (Optional) Filter comment before a date |
search | string | (Optional) Search in comment text |
Receive comments based on before and after date
To filter comments in a specific time frame, you can apply your desired filter with the help of after and before fields. For example, to receive comments before 01-01-2022, send the value after=01-01-2022 as GET.
Pay attention that the output of this endpoint is descending and after and before mean the next and previous pages, so if you want the data before the date in question, use the after field, otherwise use the before field. For more information, see Cursor Pagination section.
Example
Output
An array of Comment in CursorPagination format is output.
For more information, see Cursor Pagination section.
Comment detail
With the help of this service, you can commentId
get comment details with ID.
Webservice address
:commentId
Parameters
No Input
Output
The Comment object is sent in the output.
Comment replies
With the help of this service, you can commentId
get the list of comment responses with ID.
Webservice address
:commentId
/repliesParameters
No Input
Output
Array of Comment in Pagination format is sent in the output.
See the pagination section for more information .
Reply to comment
With the help of this service, you can commentId
add a new reply to a comment with an ID.
Webservice address
:commentId
/replyParameters
Name | Type | Description |
---|---|---|
comment | string | Comment text |
username | string | Main comment username |
Output
The created Comment object is sent to the output.
Like comment
With the help of this service, you can commentId
add or remove likes to comments with ID.
Webservice address
:commentId
/likeParameters
No Input
Output
A BooleanResponse object is sent on the output.
Change comment tag
With the help of this service, you can commentId
update the comment tags with ID.
Webservice address
:commentId
/tagParameters
Name | Type | Description |
---|---|---|
tag | integer[] | Comment tag ID |
Output
The edited Comment object is sent to the output.
Delete comment
With the help of this service, you can commentId
delete the comment with ID.
Webservice address
:commentId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
comments subscribe
With the help of this service, you can activate the desired accounts to receive comments.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
account_ids | integer[] | Account IDs |
Output
A BooleanResponse object is sent on the output.
comments social user
With the help of this service, you can get the details of the user who sent the comment with the ID socialUserId
.
Webservice address
:socialUserId
Parameters
No Input
Output
The SocialUser object is passed on the output.
Comment post detail
With the help of this service, you can get the details of the comment post with ID commentId
.
Webservice address
:commentId
/postParameters
No Input
Output
The AccountPost object is sent on the output.
Comment tags
With the help of this service, you can add tags to comments.
You can categorize comments using this feature.
Comment tags list
With the help of this service, you can get the list of all the comment tags of the desired user.
Webservice address
Parameters
No Input
Output
The array of CommentTag is passed in the output.
Create comment tag
With the help of this service, you can add a new comment tag.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
name | string | Color name |
color | string | Color HEX code |
Output
The created CommentTag object is sent to the output.
Comment tag detail
With the help of this service, you can get the details of the comment tag with ID commentTagId
Webservice address
:commentTagId
Parameters
No Input
Output
The CommentTag object is sent in the output.
Edit Comment tag
With the help of this service, you can edit the comment tag with ID commentTagId
.
Webservice address
:commentTagId
Parameters
Name | Type | Description |
---|---|---|
name | string | Color name |
color | string | Color HEX code |
Output
The edited CommentTag object is sent to the output.
Delete comment tag
With the help of this service, you can remove the comment tag with commentTagId
ID.
Webservice address
:commentTagId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
conversations
With the help of conversations service in Resont, you can manage all direct messages in your social networks through Resont.
It is possible to respond, categorize, view simultaneously, etc. in the Resont for easier and better management of messages.
Conversations list
With the help of this service, you can get the list of conversations of the desired user.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
tag | integer[] | (Optional) Conversation tag id filter |
status | string | (Optional) Conversation status filter |
search | string | (Optional) Search in conversation text |
Receive conversations based on before and after date
To filter conversations in a specific time period, you can apply your desired filter with the help of after and before fields. For example, to receive conversations before 01-01-2022, send the value after=2022-01-01 as GET.
Pay attention that the output of this endpoint is descending and after and before mean the next and previous pages, so if you want the data before the date in question, use the after field, otherwise use the before field. For more information, see Cursor Pagination section.
Example
Output
Array of Conversation in CursorPagination format is sent on output.
For more information, see Cursor Pagination section.
conversation detail
With the help of this service, you can conversationId
get the details of the conversation with the ID.
Webservice address
:conversationId
Parameters
No Input
Output
The Conversation object is sent on output.
messages list
With the help of this service, you can get the list of all conversation messages with the conversationId
desired user ID.
Webservice address
:conversationId
/messagesParameters
Name | Type | Description |
---|---|---|
date_from | string | (Optional) Filter message after a date |
date_to | string | (Optional) Filter message before a date |
Output
An array of Message is sent on the output.
message detail
With the help of this service, you can get the details of the message with the ID messageId
.
Webservice address
:messageId
Parameters
No Input
Output
The Message object is sent on the output.
Reply to conversation
With the help of this service, you can conversationId
add a new answer to the conversation with the ID.
Webservice address
:conversationId
/replyParameters
Name | Type | Description |
---|---|---|
content | string | message text |
attachment | File | (Optional) The file sent in the message |
For more information, refer to the file upload section.
Output
The created Message object is sent to the output.
Action to conversation
With the help of this service, you can conversationId
add or remove action to the conversation with ID.
Webservice address
:messageId
/reactionParameters
Name | Type | Description |
---|---|---|
type | string | The action type currently only supports the like value. |
Output
A BooleanResponse object is sent on the output.
Change conversation tag
With the help of this service, you can conversationId
update conversation tags with ID.
Webservice address
:conversationId
/tagParameters
Name | Type | Description |
---|---|---|
tag | integer[] | Conversation tag ID |
Output
The edited Conversation object is sent to the output.
Conversations subscribe
With the help of this service, you can activate the desired accounts to receive calls.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
account_ids | integer[] | Account IDs |
Output
A BooleanResponse object is sent on the output.
Conversation tags
With the help of this service, you can add tags to conversations.
With this feature, you can easily categorize conversations.
Conversation tags list
With the help of this service, you can get the list of all the conversation tags of the desired user.
Webservice address
Parameters
No Input
Output
An array of ConversationTag is sent on output.
Create conversation tag
With the help of this service, you can add a new conversation tag.
Webservice address
Parameters
No Input
Output
The created ConversationTag object is sent to the output.
Conversation tag detail
With the help of this service, you can get the details of the conversation tag with the ID conversationTagId
.
Webservice address
:conversationTagId
Parameters
No Input
Output
The ConversationTag object is sent on the output.
Edit conversation tag
With the help of this service, you can edit the conversation tag with ID conversationTagId
.
Webservice address
:conversationTagId
Parameters
No Input
Output
The edited ConversationTag object is sent in the output.
Remove conversation tag
With the help of this service, you can remove the conversation tag with conversationTagId
.
Webservice address
:conversationTagId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
Manage files
With the help of this service, you can upload a new file or manage the existing files, use me/files to see the status of the used space.
Files list
With the help of this service, you can get the list of all the files of the desired user.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
type | string | (Optional) File type filter |
search | string | (Optional) File name filter |
Output
Array of File in Pagination format is sent in the output.
For more information, see the pagination section.
Upload file
With the help of this service, you can add a new file.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
file | File | Submitted file |
For more information, refer to the file upload section.
Output
The created File object is sent to the output.
File detail
With the help of this service, you can fileId
get the details of the file with ID.
Webservice address
:fileId
Parameters
No Input
Output
The File object is sent in the output.
delete file
With the help of this service, you can delete the file with fileId
.
با کمک این سرویس میتوانید فایل با شناسه fileId
را حذف کنید.
Webservice address
:fileId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
insights
Using this service, you can analyze accounts or published content and get complete data about their status.
Account insights
With the help of this service, you can get the list of all conversation messages with the conversationId
desired user ID.
Webservice address
:accountId
Parameters
Name | Type | Description |
---|---|---|
metric | string[] | Requested data type |
period | string | One of the values week, month, three months, lifetime or custom |
date_from | string | (Optional) Start date in case of custom |
date_to | string | (Optional) end date in case of custom |
Output
An InsightsResponse object is sent on output.
post insights
With the help of this service, you can get the post group analysis data with the postGroupId
desired user ID.
Webservice address
:postGroupId
Parameters
Name | Type | Description |
---|---|---|
metric | string[] | Requested data type |
period | string | One of the values week, month, three months, lifetime or custom |
date_from | string | (Optional) Start date in case of custom |
date_to | string | (Optional) end date in case of custom |
Output
An InsightsResponse object is sent on output.
User information
This service shows the profile of the user entered with the token, all dates and times are sent to the output in the format available in this section.
User account detail
With the help of this service, you can get the details of the current user.
Webservice address
Parameters
No Input
Output
The User object is sent in the output.
User files detail
With the help of this service, you can get the details of the storage space of the logged in user.
Webservice address
Parameters
No Input
Output
The StorageInfo object is sent on the output.
Posts
In this service you can send different posts.
posts list
With the help of this service, you can get the list of the desired user's post group.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
account_ids | integer[] | (Optional) Account IDs filter |
order | string | (Optional) Determining how to sort the post by one of the id or schedule_date values |
publish_from | string | (Optional) Filter comment after a post |
publish_to | string | (Optional) Filter comment after a post |
Output
Array of PostGroup in Pagination format is sent in output.
For more information, see the pagination section.
Create post
You can add a new post with the help of this service.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
caption | string | Caption text |
custom_captions | Object | (Optional) Custom captions based on social network. The index of each member is the name of the social network and its value is a custom caption. |
type | string | Post type (one of the values text, image, album, video, document or story) |
account_ids | integer[] | Account id |
media_ids | integer[] | File id |
is_scheduled | 0|1 | scheduled post |
schedule_date | integer | `Post schedule date based on UTC` |
is_draft | 0|1 | drafted post |
location | string | The position value received from Search location |
hashtag | string[] | (Optional) Hashtag |
photo_tags | Object | (Optional) An array of image tags. The index of each member of the array is equal to the ID of the desired file. The value of each member is a representation of locationX, locationY, text and id values. The id value is equal to the pk of the users search section. |
Also, for social networks in the list below, separate entries are required, which are mentioned in each section.
InstagramOfficial parameters
Name | Type | Description |
---|---|---|
thumbnail_second | Object | Video seconds to preview. The index of each member is equal to the file ID and its second value. |
reels | 0|1 | The post is sent in the form of reels. |
reels_sharetofeed | 0|1 | Send reels to feed. |
Linkedin parameter
Name | Type | Description |
---|---|---|
linkedin_title | string | Video title |
Pinterest parameters
Name | Type | Description |
---|---|---|
pinterest_url | string | Pinterest url |
Telegram parameters
Name | Type | Description |
---|---|---|
thumbnail_second | Object | Video seconds to preview. The index of each member is equal to the file ID and its second value. |
telegram_buttons | array | Glass buttons. Each presentation member contains a string in title:link format. |
Parameters Twitter
Name | Type | Description |
---|---|---|
tweets | string[] | An array of the text of the tweets for the tweet string |
Youtube parameters
Name | Type | Description |
---|---|---|
youtube_category | string | category ID |
youtube_title | string | Video title |
youtube_privacy | string | One of the three values public - private - unlisted |
Output
The created Post object is sent to the output
Post group detail
With the help of this service, you can get the details of the post group with the ID postGroupId
.
Webservice address
:postGroupId
Parameters
No Input
Output
The PostGroup object is sent on the output.
Post detail
With the help of this service, you can postId
get post details with ID.
Webservice address
:postId
Parameters
No Input
Output
The Post object is sent on the output.
Edit post
With the help of this service, you can postGroupId
edit the post with ID.
Webservice address
:postGroupId
Parameters
Name | Type | Description |
---|---|---|
caption | string | Caption text |
custom_captions | Object | (Optional) Custom captions based on social network. The index of each member is the name of the social network and its value is a custom caption. |
type | string | Post type (one of the text, image, album, video or document values) |
account_ids | integer[] | Account id |
media_ids | integer[] | File id |
is_scheduled | 0|1 | scheduled post |
schedule_date | integer | Post schedule date based on UTC |
is_draft | 0|1 | drafted post |
location | string | The position value received from Search location |
hashtag | string[] | (Optional) Hashtag |
photo_tags | Object | (Optional) Array of image tags. The index of each member of the array is equal to the ID of the desired file. The value of each member is a representation of locationX, locationY, text and id values |
Also, for social networks in This list , separate entries are required, which are mentioned in each section.
Output
The created Post object is sent to the output
Edit post after publish
With the help of this service, you can postGroupId
edit the post with ID.
Editing is currently supported for Telegram and Instagram networks.
Webservice address
:postGroupId
/editParameters
Name | Type | Description |
---|---|---|
caption | string | Caption text |
custom_captions | Object | (Optional) Custom captions based on social network. The index of each member is the name of the social network and its value is a custom caption. |
type | string | Post type (one of the text, image, album, video or document values) |
account_ids | integer[] | Account id |
media_ids | integer[] | File id |
is_scheduled | 0|1 | scheduled post |
schedule_date | integer | Post schedule date based on UTC |
is_draft | 0|1 | Drafted post |
location | string | The position value received from Search location |
hashtag | string[] | (Optional) Hashtag |
photo_tags | Object | (Optional) An array of image tags. The index of each member of the array is equal to the ID of the desired file. The value of each member is a representation of locationX, locationY, text and id values |
Also, for social networks in this list , separate entries are required, which are mentioned in each section.
Output
The created Post object is sent to the output
Post retry
With the help of this service, you can register the post group with ID postGroupId
for retry.
Webservice address
:postGroupId
/retryParameters
No Input
Output
A BooleanResponse object is sent on the output.
Cancel post
With the help of this service, you can postGroupId
cancel the post group with ID.
Webservice address
:postGroupId
/cancelParameters
No Input
Output
A BooleanResponse object is sent on the output.
delete post
With the help of this service, you can postGroupId
delete the post group with ID.
Webservice address
:postGroupId
Parameters
No Input
Output
A BooleanResponse object is sent on the output.
Draft posts list
With the help of this service, you can get the list of the group of draft posts of the desired user.
Webservice address
Parameters
No Input
Output
Array of PostGroup in Pagination format is sent in the output.
For more information, see the pagination section.
Search
In this section, you can use the search service for some sections such as hashtag, location, stickers, etc.
Location search
With the help of this service, you can search for hashtags similar to the posted hashtag.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
query | string | Search text |
account_ids | string | Account id |
Output
The array of SearchLocation is passed in the output.
User search
With the help of this service, you can search for hashtags similar to the posted hashtag.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
query | string | Search text |
account_ids | string | Account id |
Output
The array of SearchPeople is passed in the output.
Search similar hashtags
With the help of this service, you can search for hashtags similar to the posted hashtag.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
query | string | Search text |
account_ids | string | Account id |
Output
The array of strings is sent in the output.
stickers
With the help of this service, you can add different stickers to the content published in Instagram stories.
Due to the many updates of Instagram, not all stickers may be supported in Navin Hub.
Create sticker image
With the help of this service, you can get the image based on the sent stickers.
Webservice address
:fileId
/generateImageParameters
Name | Type | Description |
---|---|---|
sticker | Sticker[] | Story stickers |
Output
The GenerateImage object is passed on the output.
Tickets
With the help of this service, you can create a ticket or a support message in Resont and communicate with different support departments.
Currently, tickets are answered 24 hours a day in Resont.
Tickets list
With the help of this service, you can get the list of tickets of the desired user.
Webservice address
Parameters
No Input
Output
The array of Ticket in Pagination format is sent in the output.
For more information, see the pagination section.
Ticket departments list
With the help of this service, you can get the list of all support units.
Webservice address
Parameters
No Input
Output
The array of Department is sent in the output.
Create ticket
With the help of this service, you can create a new ticket.
Webservice address
Parameters
Name | Type | Description |
---|---|---|
content | string | Ticket title |
department_id | string | department ID |
content | string | Content text |
attachment | File | (Optional) The file sent in the message |
For more information, refer to the file upload section.
Output
The edited Ticket object is sent to the output.
ticket detail
With the help of this service, you can ticketId
get the details of the ticket with ID.
Webservice address
:ticketId
Parameters
No Input
Output
The Ticket object is sent on the output.
ticket messages list
With the help of this service, you can get the list of all ticket messages with the ticketId
desired user ID.
Webservice address
:ticketId
/metaParameters
No Input
Output
The array of TicketMeta is passed in the output.
Reply to ticket
With the help of this service, you can ticketIdadd
a new response to the ticket with ID.
Webservice address
:ticketId
/metaParameters
Name | Type | Description |
---|---|---|
content | string | Content text |
attachment | File | (Optional) The file sent in the message |
For more information, refer to the file upload section.
Output
The edited Ticket object is sent to the output.
Close ticket
With the help of this service, you can ticketId
close the ticket with ID.
Webservice address
:ticketId
/closeParameters
No Input
Output
A BooleanResponse object is sent on the output.
Reference
In this section, you can see a complete list of items that are available in each service from the API.
This page helps you to access the list of all commands in each service much faster.
Account
Name | Type | Description |
---|---|---|
id | integer | Account id |
identifier | string | Account identifier |
name | string | Account name |
login_required | integer | Is re-login required |
relogin_reason | string | Re-login reason |
date | string | Date of Registration |
type | string | The name of the social network |
comment_subscribe | integer | Comment subscribe |
profile_url | string | profile url |
info | string | Account info |
insights_order | integer | Account insights order |
direct_subscribe | integer | Direct subscribe |
AccountGroup
Name | Type | Description |
---|---|---|
id | integer | Account group id |
name | string | Account group name |
date | string | Submitted date |
account_ids | integer[] | Account IDs in the group |
AccountPost
Name | Type | Description |
---|---|---|
id | integer | Post id |
type | string | Post type ( text, image, album, video, link, document, story ) |
post_id | string | Post unique ID |
image | string | image link |
content | string | content |
date | string | Submitted date |
like_count | integer | Like count |
comment_count | integer | Comment count |
social_user_id | integer | User ID of the sender |
user_id | integer | User ID |
account_id | integer | Account id |
permalink | string | Post permalink |
social | string | Post social network |
BooleanResponse
Name | Type | Description |
---|---|---|
success | boolean | true if the operation is successful. |
Caption
Name | Type | Description |
---|---|---|
id | integer | Caption id |
name | string | Caption name |
caption | string | Caption text |
date | string | Submitted date |
Comment
Name | Type | Description |
---|---|---|
id | integer | Comment id |
comment_id | integer | Comment unique id |
text | string | Comment text |
date | string | Submitted date |
can_delete | integer | Can delete |
can_reply | integer | Can reply |
can_like | integer | Can like |
status | integer | Status |
like | integer | Like |
post_id | string | Post id |
parent_id | string | ID of the original comment (if available) |
social_user_id | integer | User ID of the sender |
account_id | integer | Account id |
user_id | integer | User ID |
social | string | Post social network |
from | integer | ID of the original comment (if available) |
tags | CommentTag[] | Comment tags |
parentName | integer | The name of the sender of the original comment |
CommentTag
Name | Type | Description |
---|---|---|
id | integer | Tag id |
name | string | Tag name |
color | string | Tag color code |
user_id | integer | User ID |
Conversation
Name | Type | Description |
---|---|---|
id | integer | Conversation ID |
conversation_id | integer | Conversation unique ID |
update_date | string | Last modified date |
participants | ConversationParticipant[] | Conversation users |
account_id | integer | Account id |
last_message | string | Last message text |
last_seen_message_id | integer | Last seen message id |
last_seen_time | string | The date of the last message seen |
tags | ConversationTag[] | Conversation tags |
status | integer | status |
ConversationParticipant
Name | Type | Description |
---|---|---|
social_user_id | integer | User id |
socialUser | SocialUser[] | User |
CursorPagination
Name | Type | Description |
---|---|---|
data | Object | List of pagination items |
paging | Array | Pagination array with indexes before, after and total |
Department
Name | Type | Description |
---|---|---|
id | integer | Department id |
name | string | Department name |
ErrorResponse
Name | Type | Description |
---|---|---|
message | string | Error text |
type | string | Error type |
trace_id | string | Error trace ID |
File
Name | Type | Description |
---|---|---|
id | integer | File id |
title | string | File name |
filesize | integer | File size in bytes |
date | string | Submitted date |
url | string | File url |
thumbnailUrl | string | thumbnail Url |
fileType | string | File type ( image, video, document ) |
ext | string | File extension |
GenerateImage
Name | Type | Description |
---|---|---|
image | string | The generated file is base64 |
mime | string | File type |
Insights
Name | Type | Description |
---|---|---|
metric | string[] | Data name |
data | integer|string|array|object | Data Insight |
InsightsResponse
Name | Type | Description |
---|---|---|
insights | Insights[] | Array of analysis data |
metric | string[] | Loaded data |
Message
Name | Type | Description |
---|---|---|
id | integer | Message id |
message_id | integer | Message unique id |
conversation_id | integer | Conversation id |
type | string | Message type ( text, media, share, mention_story, reply_story, unsupported ) |
attachment | string | Link to the attached file (if available) |
text | string | Message text |
date | string | Submitted date |
can_delete | integer | Can delete |
can_reaction | integer | Can reaction |
social_user_id | integer | User ID of the sender |
reactions | MessageReaction[] | Message reactions |
account_id | integer | شناسه اکانت |
MessageReaction
Name | Type | Description |
---|---|---|
social_user_id | integer | User ID |
is_owner | boolean | It is true if it is the owner of the account |
socialUser | SocialUser[] | User |
Pagination
Name | Type | Description |
---|---|---|
data | Object | List of pagination items |
paging | Array | Pagination array with prev, next, page, total and totalPage indexes |
Post
Name | Type | Description |
---|---|---|
id | integer | Post id |
caption | string | caption |
media_ids | integer[] | Post media ids |
account_id | integer | Account id |
publish_date | string | Publish date |
location | string | Location |
status | string | Status |
log | string | Post error text |
PostGroup
Name | Type | Description |
---|---|---|
id | integer | Post group id |
type | string | post type |
is_scheduled | string | scheduled post |
create_date | string | Create date |
schedule_date | string | Schedule date |
from_user | string | Sender`s name (if sending from the panel) |
caption | string | Caption |
RedirectResponse
Name | Type | Description |
---|---|---|
redirect | string | The address of the page to which the user needs to be redirected. |
SocialUser
Name | Type | Description |
---|---|---|
id | integer | User id |
username | string | username |
name | string | name |
image | string | Profile image |
social | string | Post social network |
SearchLocation
Name | Type | Description |
---|---|---|
id | integer | Location id |
name | string | Location name |
description | string | description |
social | string | social network name |
lat | string | latitude value |
lng | string | longitude value |
type | location | Constant |
SearchPeople
Name | Type | Description |
---|---|---|
pk | integer | User id |
username | string | username |
profile_pic_url | string | Profile picture url |
StorageInfo
Name | Type | Description |
---|---|---|
total_files | integer | Total number of files |
max_file_size | integer | The upload limit for each file |
max_file_size_readable | string | Upload limit of each formatted file |
total_storage | integer | Total available space |
total_storage_readable | string | All available space is formatted |
used_storage | integer | space used |
used_storage_readable | string | Formatted used space |
remaining_storage | integer | Remaining space |
remaining_storage_readable | string | Formatted remaining space |
Ticket
Name | Type | Description |
---|---|---|
id | integer | Ticket ID |
title | string | Ticket title |
status | integer | Status |
date | string | Formatted date |
department_id | integer | Department ID |
status_name | string | Status name |
rate | integer | Rate |
TicketMeta
Name | Type | Description |
---|---|---|
id | integer | Message ID |
content | string | Message text |
date | string | Formatted date |
ticket_id | integer | Ticket ID |
attachment | string | Attached link (if available) |
report | string | Report text |
user | TicketUser | Sending user |
TicketUser
Name | Type | Description |
---|---|---|
name | string | name |
firstname | string | firstname |
lastname | string | lastname |
isAdmin | string | Is Admin |
User
Name | Type | Description |
---|---|---|
string | ||
user_type | string | User type ( real, legal ) |
national_code | string | National code (if true) |
company | string | Company name (if legal) |
national_id | string | National ID (if legal) |
tax_number | string | Economic code (if legal) |
registration_number | string | Registration number (if legal) |
mobile | string | mobile |
name | string | name |
package_id | integer | package id |
timezone | string | timezone |
dateformat | string | date format |
timeformat | string | time format |
language | string | language |
expire_date | string | expire date |
packageTitle | stringr | package title |
emailactive | string | email active |
smsactivate | integer | sms active |
has_webservice | string | has webservice |
activity | string | activity |
postal_code | string | postal code |
address | string | address |