{"info":{"_postman_id":"be876c6d-95c2-4a23-b591-a1d4d83c8347","name":"Public Simasti.com API","description":"

The Simasti API enables you to manage your client account programmatically.

It provides endpoints to manage your balance, send individual messages and campaigns, and view reports.

The REST API operates over the secure HTTPS protocol, providing a range of methods to make requests and return responses for each operation.

All responses are in JSON structures, with all references to API requests in the documentation including the mandatory base URL: https://my.simasti.com

if specified \"required\"- this parameter is mandatory in the API call and must always be set with an appropriate value
\n
If specified \"Optional\" you can ommit this parameter altogether from the API call, in this case, default values will be set implicitly.
\n

Authentication

Before making use of the APIs, you will need:

A JWT token received on /login call. This token is transmitted in the headers of any request, except when the token itself is received - then it is not required.
\n
- the token will be provided after calling the Authentication / login api call, using the login/password you were provided with
\n
Example for required headers for authentication:
\n

curl -X 'POST' 'https://my.simasti.com/api/v1/message-send'-H 'accept: application/json' -H 'Authorization: Bearer _MwMzQzODA\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*4MzAzNzk4MH0.s_SFtikTgjACDwGvr0DQ'

where the Authorization: Bearer is the received token.

The default life time of the token is 2 hours, this can be adapted to your system's needs. please request that from support@simasti.com

Error codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Identifier	Description
0	SUCCESS	Successful request.
1	E_UNKNOWN	Unknown error occured.
2	E_INTERNAL	Simasti internal error occured.
3	E_OVERLOAD	Too much requests.
4	E_AUTHENTICATION	Common authentication error. It could be bad login/password/token/access denied or disable account.
5	E_BAD_LOGIN	Wrong or absent account.
6	E_BAD_PASSWORD	Wrong password.
7	E_BAD_CREDENTIALS	Wrong login/password or absent account.
8	E_TOKEN_INVALID	Bad access token.
9	E_TOKEN_EXPIRED	Access token is expired.
10	E_BAD_SMS_CODE	Bad SMS verification code entered.
11	E_USER_NOT_FOUND	User not found.
12	E_USER_ALREADY_EXIST	User already exists.
13	E_USER_INACTIVE	User disabled by administrator.
14	E_USER_AGENCY_INACTIVE	Agency disabled by administrator.
15	E_MODULE_ACCESS_DENIED	Request not allowed for this user.
16	E_BAD_PARAMETER	Bad parameter or value in request.
17	E_ITEM_NOT_FOUND	Object not found.
18	E_ITEM_WITH_ID_NOT_FOUND	Object with such ID not found.
19	E_ITEM_ALREADY_EXIST	Object with such parameters already exists.
20	E_PASSWORD_EQUAL_LOGIN	Password should not match with login.
21	E_AGENCY_NOT_FOUND	Agency not found.
22	E_USER_ACCESS_DENIED	Access denied for user.
23	E_AGENCY_ACCESS_DENIED	Access denied for user from agency.
24	E_ACCOUNT_ACCESS_DENIED	Access denied fro account.
25	E_CLIENT_ACCESS_DENIED	Access denied for client.
26	E_NETWORK	Unknown network error.
27	E_NETWORK_REQUEST	Network error occured while request.
28	E_NETWORK_RESPONSE	Network error occured while response.
29	E_NETWORK_CONNECTION	Network connection error.
31	E_NETWORK_CONFIGURATION	Network configuration error.
33	E_CLIENT_NOT_FOUND	Client not found.
34	E_ACCOUNT_NOT_FOUND	Account not found.
35	E_ACCOUNT_CREDENTIALS_SAVE	Can't save account credentials.
36	E_ACCOUNT_CREDENTIALS_READ	Can't read account credentials.
37	E_ACCOUNT_CREDENTIALS_UPDATE	Can't change account credentials.
38	E_ACCOUNT_CREDENTIALS_DELETE	Can't delete account credentials.
39	E_ACCOUNT_CREDENTIALS_NOT_FOUND	Can't find account credentials.
40	E_PROVIDER	Unknown message provider error.
41	E_PROVIDER_BAD_REQUEST	Bad request to message provider.
42	E_PROVIDER_UNAUTHORIZED	User is not authorized on message provider side.
43	E_PROVIDER_FORBIDDEN	Access forbidden on message provider side.
44	E_PROVIDER_NOT_FOUND	Message provider not found.
45	E_PROVIDER_METHOD_NOT_ALLOWED	Message provider method not allowed.
46	E_PROVIDER_TIMEOUT	Request timeout on message provider.
47	E_PROVIDER_OVERLOAD	too much request for message provider.
48	E_PROVIDER_INTERNAL	Message provider internal error.
49	E_PROVIDER_BAD_GATEWAY	Message provider bad gateway.
50	E_PROVIDER_SERVICE_UNAVAILABLE	Message provider is not available.
51	E_PROVIDER_GATEWAY_TIMEOUT	Message provider gateway timeout.
52	E_PROVIDER_BAD_PARAMETER	Bad parameter or value at message provider request.
53	E_PROVIDER_BAD_CREDENTIALS	Message provider bad login, password or token.
54	E_PROVIDER_BAD_RESPONSE	Message provider bad response.
55	E_PROVIDER_LOW_BALANCE	Message provider low balance.
56	E_PROVIDER_BAD_TARGET_NUMBER	Message provider bad target number.
57	E_PROVIDER_BAD_SOURCE_NUMBER	Message provider bad source number.
58	E_PROVIDER_MESSAGE_TOO_LONG	Message too long for message provider.
59	E_PROVIDER_MESSAGE_EXPIRED	Message expired.
60	E_PROVIDER_MESSAGE_NOT_DELIVERED	Message not delivered.
61	E_PROVIDER_MESSAGE_UNDELIVERABLE	Message is undeliverable.
62	E_PROVIDER_FATAL	Message provider fatal error.
63	E_PROVIDER_SYSTEM	Message provider system error
64	E_PROVIDER_DISABLED	Message provider is disabled or suspended.
65	E_PROVIDER_ADAPTER_DISABLED	Message provider adapter is disabled.
70	E_BAD_TARGET_NUMBER	Bad target number.
71	E_BAD_SOURCE_NUMBER	Bad source number.
72	E_LOW_BALANCE	Low balance for client or agency.
73	E_NOT_DELIVERED	Message not delivered.
74	E_INVALID_NUMBERS	Bad one more target numbers from list.
76	E_MESSAGE_TOO_LONG	Message too long.
77	E_SEND_TIME_ERROR	Send time bad parameter value.
78	E_INSUFFICIENT_CREDIT_MESSAGE_PENGIND	Insufficient balance for pending messages.
80	E_PRICING_MODEL_NOT_FOUND	Pricing model not found for this account.
81	E_PRICING_RULE_NOT_FOUND	Pricing rule not found for this account.
82	E_PRICING_RULE_BAD_CONFIGURATION	Bad configuration for pricing rules.
83	E_INSUFFICIENT_CLIENT_CREDIT	Low client balance.
84	E_INSUFFICIENT_AGENCY_CREDIT	Low agency balance.
85	E_BAD_PHONE_NUMBER	Bad phone number format.
86	E_BAD_PHONE_COUNTRY	Phone number country is not supported.
87	E_TRY_TO_ACCESS_NOT_ALLOWED_ITEM	Access denied for request.
88	E_INVALID_ROLE	Bad user role.
89	E_KPI_NOT_EXIST	Key Performance Indicators (KPI) value does not exist.
90	E_STOP_WORD_NOT_FOUND	Stop word not found.
91	E_STOP_WORD_REACHED_MAXIMUM	Stop word count reached maximum.
92	E_DISALLOW_TO_SEND_SMS	SMS sending is forbidden for account.
93	E_CONTACT_BOOK_METADATA_COUNT	Reached maximum metadata count for client contact book.
94	E_CONTACT_BOOK_NOT_ALLOWED_METADATA_FIELD	Not allowed metadata field for contact book.
95	I_NO_CAMPAIGN_TO_HANDLE	No campaign to handle.
96	I_NO_MESSAGE_TO_HANDLE	No message to handle for campaign.
97	E_CAMPAIGN_NOT_FOUND_TO_START	Campaign not found to start.
98	E_CAMPAIGN_ALREADY_STARTED	Campaign already started.
99	E_CAMPAIGN_COUNTRIES_NOT_FOUND	Campaign countries not found.
100	E_ROUTING_RULE_NOT_FOUND	Routing rule not found. Please contact the support.
101	E_TOO_MANY_MAPPINGS	Too many mappings for campaign.
102	E_MAPPING_EXISTS	Mapping already exists for campaign.
103	E_ADAPTER_ALREADY_IN_THIS_STATUS	Message provider adapter already in this status.
104	E_ADAPTER_CANT_BE_ACTIVATED	Message provider adapter can't be activated.
105	E_MMS_CONTENT_NOT_PROVIDED
106	E_DISALLOW_TO_SEND_MMS
107	E_FILE_SIZE_LIMIT_REACHED
108	E_BAD_FILE_UPLOAD
109	E_PHONE_NO_ANSWER
110	E_NONE_MESSAGE_TYPE_SETTINGS
111	E_DISALLOW_TO_SEND_VOICE_MESSAGE
112	E_UNKNOWN_MESSAGE_TYPE
113	E_VOICE_MESSAGE_TO_KOSHER_NUMBER_DISABLED
114	E_FROM_SHOULD_BE_NUMBER_FOR_KOSHER_NUMBERS
115	E_VERIFY_TOKEN_IS_INVALID
116	E_TO_SHOULD_NOT_BE_EMPTY
117	E_BAD_CONTENT_LINK
118	E_NOTIFICATION_MISSING_CONTACTS
119	E_NOTIFICATION_TOO_MANY_CONTACTS
120	E_AGENCY_INTERNAL
121	E_AGENCY_NOT_INTERNAL
122	E_ACCOUNT_DISABLED
123	E_PROVIDER_MESSAGE_UNDELIVERABLE_NO_DEVICE_RESPONSE
124	E_PHONE_CALL_BARRED
125	E_PHONE_NO_MMS_SUPPORT
126	E_MMS_FILE_ERROR
127	E_DISALLOW_TO_SEND_MAIL_TO_SMS
128	E_DISALLOW_TO_SEND_PREMIUM_MESSAGE
129	E_DUPLICATE_MESSAGE
130	E_EMAIL_ACCOUNT_ALREADY_VERIFIED
131	E_DUPLICATE_MESSAGE_THROTTLER
132	E_DISALLOW_TO_SEND_FLASH_SMS
133	E_REPORT_NOT_FOUND
134	E_REPORT_DATE_INVALID
135	E_SMPP_LOGIN_TOO_LONG
136	E_NUMBER_BLOCKED_DNC
137	E_MESSAGE_BLOCKED_DO_NOT_SEND_WINDOW
138	E_DISCOUNT_NON_APPLIABLE
139	E_CREDIT_POOL_NOT_FOUND
140	E_SMPP_SESSION_DISCONNECTED
141	E_ACCOUNT_LOGIN_ALREADY_USED
142	E_FORBIDDEN_MESSAGE_CONTENT
143	E_DISALLOW_TO_SEND_OTP
144	E_VERIFICATION_NUMBER_BLOCKED
145	E_VERIFICATION_EXPIRED_OR_NOT_CREATED
146	E_VERIFICATION_SERVICE_UNAVAILABLE
147	E_SMPP_CONNECTION_POOL_EMPTY
148	E_CAMPAING_NOT_FOUND
149	E_CAMPAIGN_NOT_CANCELLED
150	E_CAMPAIGN_CANCELLED_LIST_NOT_READY
151	E_CAMPAIGN_CANCELLD_LIST_UNAVAILABLE
152	E_AGENCY_HAS_CLIENTS
153	E_CAMPAIGN_CANCELLED
154	E_PASSWORD_RESET_LINK_INVALID
155	E_CAPTCHA_REQUIRED
156	E_CAMPAIGN_TEMPLATE_LIMIT_REACHED
157	E_CAPTCHA_VERIFICATION_FAILED
158	E_EMAIL_ALREADY_USED
159	E_ACCOUNT_DISABLED_TOO_MANY_WRONG_CODES

When should you retry sending a failed message?

Note that Simasti has its internal retry mechanism, which also switch's between the available Cellular opeator for the specific message. So it is highly not encouraged to retry sending a message, in any case the submit to Simasti returned 2XX

When to retry ? only on the following HTTP responses : 500, 429,502,503

Operational or OTP messages

Simasti offers an optimised message processing for sending time critical messages such as 2fa codes etc. In order to utilise this capability, please include the parameter isOTP=true in your message_send call. This way your time critical messages will \"bypass\" the marketing messages and will be sent promptly.

Delivery reports & Inbound SMS & Webhooks

DLR

note: if you need to whitelist our ip, please whitelist the following IP address: 34.159.168.8

Webhooks are automated messages sent from applications when certain events occur. In the case of a delivery report webhook, this event is the delivery status of a message.

When configured to use webhooks, the application will send a ,messsage to the webhook (specified web address), with details of the delivery report, such as the status, delivery timestamp and other associated data.

The structure of DLR is as follows:

{\n  \"messageId\": \"6405c60994590434f55a3cty\",\n  \"customSendId\": \"exampleSendId\",\n  \"to\": \"+972552603210\",\n  \"status\": \"delivered\",\n  \"messageQnt\": 1,\n  \"submitDate\": \"2023-03-06T10:52:57.656Z\",\n  \"error\": 0,\n  \"errorDescription\": \"Successful request.\"\n}\n\n

The webhook response contains information about the submission of a message to a given phone number. It includes the message id, the phone number the message was sent to, the status of the message (whether it was delivered or not), the number of messages sent, the date and time when the message was submitted, the date and time when the message was delivered, and an error code (with 0 indicating no errors). Also, if customSendId parameter was passed when sending a message, it will also be received in DLR.

Incoming / Inbound SMS

note: if you need to whitelist our ip, please whitelist the following IP address: 34.159.168.8

Incoing or Inbound sms, is an sms that is sent from your customers to a virtual number you've purchased for your business, from Simasti ( ask support@simasti.com ). These can be messages such as unsubscribe replies ( Stop, etc ), event confirmation or any other business case you might come with.

Once Simasti recieves an incoming SMS, it first identifies the Virtual number that it was sent to, in order to know know that it belongs to your brand. and then a POST call to the webhook will be executed.

You can define a webhook per each of the virtual numbers that are configured for your account.

each Incoming message- will be forwarded to the respective webhook that is define for that specific virtual number.

If for a specific virtual number, no webhook is defined, the Inbound messages are sent to the same webhook that is set for the DLR.

The incoming POST call will have this structure:

{\n    \"target\": \"0529999555\",\n    \"source\": \"0529999555\",\n    \"text_utf8\": \"webhook test\"\n}\n\n

Target : the virtual number

source : the recipients number

text_utf8: the body of the message that was received

Mail2Voice

Mail to voice is a method of sending TextToVoice via Email. its done by sending an email to a defined email of Simasti. The email is then processed, a respective Text To Voice is triggered.

To send sms Text To Voice using Email, you must first register your email addresses in the Simasti system (please contact Simasti's support) . Once registered, you can send Text To Voice by following a specific email format, which is outlined below.

Note, the identity is determined by the sender's email address, so its critical to register the correct email addres from which Simasti will receive the email-2-sms requests.

To activate the necessary settings for each client, our Backoffice system must be accessed. (contact your admin for details) The email format required is as follows:

The email is sent to the Simasti mailbox
\n
The mailbox to send to is mail2voice@simasti.com
\n
Use the following subject format: \"From: [Sender's name] To: [comma-separated target numbers in international format, for example: From:Sendername To:+972552603210,+972552603211
\n
Include the message text in the body of the email. Sent email should be plain text, not HTML.
\n
Example usage: From:Sendername To:+972552603210,+972552603211
\n

Short Tracked Links

Simasti offers you the possibility to send URLs which in most cases are going to be significatnly shorter then your original URL, and would be tracked by simasti.

Please refer to the Short Links api call

To use this : please generate the links using POST short-links. GET short-links

Mail2Sms

Mail to SMS is a method of sending SMS via Email. its done by sending an email to a defined email of Simasti. The email is then processed, a respective SMS is generated and sent with the content that is specified in the email.

To send sms messages using Email, clients must first register their email addresses in the Simasti system (please contact Simasti's support) . Once registered, clients can send messages by following a specific email format, which is outlined below.

Note, the identity is determined by the sender's email address, so its critical to register the correct email addres from which Simasti will receive the email-2-sms requests.

To activate the necessary settings for each client, our Backoffice system must be accessed. (contact your admin for details) The email format required is as follows:

The email is sent to the Simasti mailbox
\n
The mailbox to send to is mail2sms@simasti.com
\n
Use the following subject format: \"From: [Sender's name] To: [comma-separated target numbers in international format, for example: From:Sendername To:+972552603210,+972552603211
\n
Include the message text in the body of the email. Sent email should be plain text, not HTML.
\n
In the Mail2SMS subject, you have the option to include a non-mandatory parameter, \"delay:\", to control the delay for sending the SMS via the API call.By specifying this parameter, you can customize the delay period before the SMS is sent. The default value is set to 0 if no value is provided.Example usage: From:Sendername To:+972552603210,+972552603211 delay:60This will set the delay parameter to 60 seconds for the SMS to be sent.
\n
Please note that only regular SMS can be sent via Mail2sms.
\n

Personalising your SMS

The sms body can be personlised with content that you upload with your contact list. In order to do that you need to:

Create meta data fields - using this endpoint
\n
Upload the data - using this endpoint
\n
Use the tags in the message body - using this endpoint (when sending campaign messages)
\n

For example, after importing metadata with following fields:

curl --location 'https://my.simasti.com/api/v1/contact-list/import/mapping'

--header 'Content-Type: application/json' --header 'Authorization: {{vault:bearer-token}}?iH****\\\\\\\\\\*LZZmH6yn' --data '{\"contactListName\": \"ContactList1\", \"fileName\": \"ContactListCsv.csv\", \"delimeter\": \";\", \"phone\":{ \"index\": 0 }, \"metadata\":[ {\"name\":{\"index\": 1}}, {\"description\":{\"index\": 2 }} ] }'

A request with metadata fields for sending campaign message can be used:

curl --location 'https://my.simasti.com/api/v1/campaign/send'

--header 'Content-Type: application/json' --header 'Authorization: {{vault:bearer-token}}?**' --data '{ \"name\": \"CampaignName\", \"messageTemplate\": \"Hello [#name#]! We have a special offer for you: [#description#]\", \"source\": \"SenderName\", \"type\": \"sms\", \"contactListIds\": [ \"648825d51d2301a40bf6fb76\" ] }'

Codes Pool, Sending Coupons to your customers.

You can Automatically send codes to your customers.

The codes can either be generated by you, or will be generated by us and handed over to you.
\n
you can select how many codes are going to be sent
\n
Once all codes are consumed / sent to customers, any further SMS's, in the case there are more SMS's then codes, SMS's will fail and a respective DLR will be sent.
\n
The codes are grouped under a \"tag\"
\n
- you can have multiple tags / code pulls for different purposes.
\n

important: There is no interface to upload the codes, right now its done in the backend.

In order to run a coupon campaign, you will need to:

1. in your SMS's body, place the following place holder: [#code#]

2. make sure the codes are uploaded ( please contact us for that ).

3. select a tag under which these codes are going to be uploaded.

4. send your API calls with the following parameter :

applyDiscountCode=<TagName>\n\n

Sending Verification Codes

note, this function has a pre-requiisite : A virtual number.

If you need the functionality of sending a Verification Code, and verify the reply. There is a simple pair of methods that saves you the mechanism of generating, maintaing the life time etc of the code.

Please refere to OTP Verification

The process would be as follows:
1. send-otp

to send a verification code to a recipient. The system will generate and send a code with a standard message to the recipient. you do not need to generate the code .

The recipient is then replying with the code that was sent to him/her.
2. verify-otp , to see if the code that the recipient has sent is the correct code, and if its within the defined time.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Error codes","slug":"error-codes"},{"content":"Operational or OTP messages","slug":"operational-or-otp-messages"},{"content":"Delivery reports & Inbound SMS & Webhooks","slug":"delivery-reports-inbound-sms-webhooks"},{"content":"Incoming / Inbound SMS","slug":"incoming-inbound-sms"},{"content":"Mail2Voice","slug":"mail2voice"},{"content":"Short Tracked Links","slug":"short-tracked-links"},{"content":"Mail2Sms","slug":"mail2sms"},{"content":"Personalising your SMS","slug":"personalising-your-sms"},{"content":"Codes Pool, Sending Coupons to your customers.","slug":"codes-pool-sending-coupons-to-your-customers"},{"content":"Sending Verification Codes","slug":"sending-verification-codes"}],"owner":"24456169","collectionId":"be876c6d-95c2-4a23-b591-a1d4d83c8347","publishedId":"2sB3HjM1Nx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-09-02T19:55:17.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"8644a4b9-3d72-4101-9a11-de80e9be5dd0","exec":["let jsonData = JSON.parse(responseBody);\r","\r","let schema = {\r"," \"properties\": {\r"," \"token\": {\"type\": \"string\"},\r"," \"account\": {\"type\": \"object\"}\r"," }\r","};\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});\r","\r","try {\r"," pm.environment.set(\"user_token_client\", jsonData.token);\r","} catch(e) {\r"," console.log(e);\r","}\r","\r","try {\r"," pm.environment.set(\"account_id\", jsonData.account.id);\r","} catch(e) {\r"," console.log(e);\r","}\r",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c938ec8f-0835-4932-934d-e966aecd4219","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"login\": \"string\",\r\n \"password\": \"string\"\r\n \"expireInHours\" :\"24\" //24h\r\n }","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/auth/login","description":"

The/login endpoint is used for user authentication. Returns JSON Web Token (JWT) for all other endpoints access. JWT expires in 1 hour after /login call.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
login	string	User account login (email)	required
password	string	User account password.	required
expireInHours	Integer	TTL of the token. how long should the token be alive. default 2 h	Optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
token	string	User access token (JWT). Used for authentication (bearer).
clientId	string	id of user's client in our system
name	string	User name
login	string	User account login (email)

","urlObject":{"protocol":"https","path":["api","v1","auth","login"],"host":["my","simasti","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"013b96c4-74e4-4104-8f35-5e2caebf3071","name":"Login","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"login\": \"email@example.com\",\r\n \"password\": \"password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"{{vault:json-web-token}}\",\n \"account\": {\n \"clientId\": \"1\",\n \"name\": \"Name Surname\",\n \"login\": \"email@example.com\"\n }\n}"}],"_postman_id":"c938ec8f-0835-4932-934d-e966aecd4219"},{"name":"Logout","id":"22c6ee3c-4de8-442f-ace6-54ecb9fe9e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.simasti.com/api/v1/auth/logout","description":"

Invalidates all issued JWT tokens.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c28fd708-4a14-4902-9da1-e627040bd698","id":"c28fd708-4a14-4902-9da1-e627040bd698","name":"Authentication","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","auth","logout"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"e96e79d8-73eb-4de8-afb9-7c8ac13ce698","name":"Logout","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","disabled":true}],"url":{"raw":"https://my.simasti.com/api/v1/auth/logout","protocol":"https","host":["my","simasti","com"],"path":["api","v1","auth","logout"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"22c6ee3c-4de8-442f-ace6-54ecb9fe9e9a"}],"id":"c28fd708-4a14-4902-9da1-e627040bd698","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a6d2fb97-843d-431e-ba39-ff8efb734992"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f77a5164-ebb0-40ef-81e9-efd5216c5f3d"}}],"_postman_id":"c28fd708-4a14-4902-9da1-e627040bd698","description":""},{"name":"SMS","item":[{"name":"Message Validate","id":"c0edbeb1-3b6e-4f8f-91c2-d0034771fd2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message\": \"test\",\r\n \"from\": \"test number\",\r\n \"to\": [\r\n \"+972552992023\"\r\n ],\r\n \"immediate\": false, \r\n \"dlrState\": \"success\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-validate","description":"

The /message-validate endpoint is used for validating message, calculating its cost, checking if phone numbers are valid and included in grey/black list and returning reason for that.

Can validate simple and flash SMS. Flash SMS have some restriction: max length must be 140 bytes or less.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
message	string	The text of the SMS.	required
from	string	Virtual Number.	required
to	array	An array of up to 10,000 phone numbers with plus sign (international format).	required
flashMessage	boolean	Send Flash SMS. (default: false)	required
dlrState	string	Indicates if DLR will be sent. Accepted values: \"disabled\" - no DLR will be sent, \"all\" - will be sent t on success and failure, \"success\" - will be sent only on success, \"failure\" - will be send only on failure.	required

Response values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
blacklist	array	Blacklisted phone numbers.
greylist	array	Greylisted phone numbers.
invalidlist	array	Bad phone numbers list.
phone	string	Phone number.
reason	string	The reason why the number is on the list.

","urlObject":{"protocol":"https","path":["api","v1","message-validate"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"5637f43b-813a-42a5-852a-fd11be78eb7f","name":"Message Validate example","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"message\": \"test\",\r\n \"from\": \"+972529998460\",\r\n \"to\": [\r\n \"+972552992023\"\r\n ],\r\n \"immediate\": false, \r\n \"dlrState\": \"success\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"118"},{"key":"x-ratelimit-reset","value":"27"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"47"},{"key":"Date","value":"Tue, 25 Oct 2022 05:56:32 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"blacklist\": [],\n \"greylist\": [],\n \"invalidlist\": []\n}"}],"_postman_id":"c0edbeb1-3b6e-4f8f-91c2-d0034771fd2e"},{"name":"Message Send","id":"c8ac7e0b-0f3c-447d-b10a-36843596815e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message\": \"test message\",\r\n \"from\": \"Source number example\",\r\n \"to\": [\r\n \"+972552992023\", \"+972552603210\"\r\n ], \r\n \"flashMessage\": false, \r\n \"dlrState\": \"all\",\r\n \"isPremium\": false,\r\n \"isOTP\": true, \r\n \"delay\": 3600,\r\n \"customSendId\": \"CustomSendIdExample\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-send","description":"

The /message-send endpoint is used for sending messages to list of phone numbers. Before sending, method performs parameters checks and validations.
Can send simple or flash SMS. Flash SMS have some restriction: max length must be 140 bytes or less.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
message	string	The text of the SMS.	required
from	string	Virtual Number. A fully qualified international phone number, or 3-11 alphanumeric characters ( no special signs or spaces allowed )	required
to	array	An array of up to 10,000 phone numbers with plus sign (international format).	required
flashMessage	boolean	Send Flash SMS. (default: false) * refrain from using this in the call, if not used	optional
dlrState	string	Indicates if DLR will be sent. Acepted values: \"disabled\" - no DLR will be send, \"all\" - will be sent on success and failure, \"success\" - will be sent only on success, \"failure\" - will be sent only on failure.	required
isOTP	boolean	Defines if message is an OTP message (priority rule would be affected). (default: false)	optional
isPremium	boolean	Flag which determines if message should be premium international route. do not use for sending in Israel (default: false) * refrain from using this in the call, if not used	optional
customSendId	string (3-64 characters)	Client custom send ID. The value will be included in the response and in the DLR. Only one custom-send-ID per request is supported. * refrain from using this in the call, if not used	optional
delay	number	Defines message-sending startTime delay in seconds. Puts a message to the scheduler queue for sending in UTC.now + delay. Values: minimum: 1; maximum: 3600; default - 0. When using a delay parameter, isOTP parameter will be ignored. * refrain from using this in the call, if not used	optional
webhook	URL	When specified, will override the account's settings and will send the DLR / Inbound messages for this particular API call, to the specified URL * No checks or validations are done on the validity of this url. * refrain from using this in the call, if not used	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
responseCode	number	0 : Success, Not 0 : validation error. the call contains wrong / malformed parameters.
cost	number	Total cost for all messages. in the currency set for this type of message ( configurable ).
sent	array	Messages ID with phone numbers array.

Notes:

Messages can be sent in any language (depending on available encoding for your Client Account - shoud be set up via Admin Interface). API error messages and responses will all be in English only
\n
When the API receives a message request but does not have enough Credit, these messages will NOT be sent. A dlr will be sent per recipient with error 78 \"E_INSUFFICIENT_CREDIT_MESSAGE_PENGIND\"
\n
A Flash SMS is a type of SMS that appears directly on the main screen without user interaction and is not automatically stored in the inbox. It can be useful in emergencies, such as a fire alarm or cases of confidentiality, as in delivering one-time passwords.
\n
Difference between isPremium and isOTP parameters: for messages sent with isOTP: true parameter, a separate queue will be created. For messsages sent with isPremium: true parameter, a specific routing rule from operator will be applied.
\n

Duplicates prevention

Simasti offers a mechanism that safeguards you from \"flooding\" your clients with identical messages in a short period of time ( for example, due to a coding error ). This mechanism will prevent a message to be sent to a recipient if:

the message body is identical
\n
it is within the accounts \"duplication prevention window\" ( configurable, contact support for more )
\n
the number is identical.
\n

messages that will be cancelled by this mechanism will return. - E_DUPLICATE_MESSAGE_THROTTLER. In such error case DLR is not sent .

this mechanism applies per recipient in the call. so if a an api call is submitted with multiple numbers, only those numbers that will match the duplication prevention rules will fail, others will be successfully sent.

Duplicate checking affect only for next message types:

SMS
\n
FLASH SMS
\n
VOICE MESSAGE ( kosher numbers )
\n
PREMIUM ( INTERNATIONAL ) MESSAGE - messages sent out of ISRAEL
\n

\n","urlObject":{"protocol":"https","path":["api","v1","message-send"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"72e6ba68-67bf-4ee4-b06f-4a2979a7e189","name":"Message Send","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"message\": \"test message\",\r\n \"from\": \"Source number example\",\r\n \"to\": [\r\n \"+972552992023\",\r\n \"+972552603210\"\r\n ],\r\n \"dlrState\": \"all\",\r\n \"isOTP\": true,\r\n \"customSendId\": \"CustomSendIdExample\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"37"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"118"},{"key":"Date","value":"Tue, 25 Oct 2022 14:19:27 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": 0,\n \"customSendId\": \"CustomSendIdExample\",\n \"cost\": 4,\n \"sent\": [\n {\n \"messageId\": \"6357f06fd6a28212336a58ef\"\n },\n {\n \"messageId\": \"6357f06fd6a28456a86a58f0\"\n }\n ]\n}"}],"_postman_id":"c8ac7e0b-0f3c-447d-b10a-36843596815e"},{"name":"Personalized Message Send","id":"99f263ca-39cb-4d48-a0d2-bf88e923ed96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"message\": \"Hi [#customerName#], your OTP code is [#otpCode#]. This is [#someOtherKey#||defaultValue#] test\",\r\n \"from\": \"Source number example\",\r\n \"to\": [\r\n {\r\n \"phone\": \"+972552603210\",\r\n \"templateValues\": {\r\n \"customerName\": \"John\",\r\n \"otpCode\": \"1997\",\r\n \"someOtherKey\":\"1\"\r\n }},\r\n \r\n {\r\n \"phone\": \"+972552992023\",\r\n \"templateValues\": {\r\n \"customerName\": \"Tom\",\r\n \"otpCode\": \"2003\"\r\n }\r\n }\r\n ],\r\n\r\n \"flashMessage\": false, \r\n \"dlrState\": \"all\",\r\n \"isPremium\": false,\r\n \"isOTP\": true, \r\n \"delay\": 3600,\r\n \"customSendId\": \"CustomSendIdExample\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-send/personalized","description":"

This request can be used for sending personalized messages to multiple recipients in a single API call.

The /message-send/personalized endpoint is used for sending personalized messages to a list of phone numbers. Each message template may contain variables that will be replaced with custom data based on the templateValues object for each phone number in the request payload.

Your message template contains placeholders enclosed in square brackets, such as [#customerName#], [#otpCode#], and [#someOtherKey#||#defaultValue#]. These placeholders represent variables that will be dynamically replaced with values from the templateValues object for each recipient.

Example Message Template:

\"Hi [#customerName#], your OTP code is [#otpCode#]. This is [#someOtherKey#||#defaultValue#] test\"

templateValues Object:

For each recipient specified in the to array, you provide a templateValues object.
\n
This object contains key-value pairs, where the keys correspond to the placeholders in the message template, and the values are the data that should replace those placeholders for that recipient.
\n

Example templateValues for Recipient John (see Example Request):

{ \"customerName\": \"John\", \"otpCode\": \"1997\", \"someOtherKey\": \"1\" }

In this example, customerName, otpCode, and someOtherKey are keys in the templateValues object, and their respective values are used to replace the corresponding placeholders in the message template.

Replacement Rules:

When the message is sent to a specific recipient, the placeholders in the message template are replaced with the values from that recipient's templateValues object.
\n
If a placeholder does not have a corresponding key in the templateValues object, we do put a space instead.
\n

You can provide a default value for a placeholder using the || operator. If the key is not found in the templateValues object, the default value is used.

Example Message Sent to Tom:

\"Hi Tom, your OTP code is 2003. This is defaultValue test\"

In the message sent to Tom, the [#someOtherKey#||defaultValue#] placeholder has been replaced with the default value \"defaultValue\" because there is no someOtherKey key in Tom's templateValues object.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value	Cardinality	Notes
message	string	The text of the SMS. The message template with placeholders for customization. Placeholders are enclosed in square brackets (e.g., [#customerName#], [#otpCode#]).	required
from	string	Virtual Number.	required
to	array[Objects]	An array of up to 1000 Objects that include an obligatory \"phone: parameter in an international format ( including + sign and country code ) and OPTIONAL: templateValues - A key-value object that satisfies the dynamic fields in the message body.	required	Since this call includes arbitrary size data ( e.g. the content of the tags). it might get too big, if you get error type 2 -\"Request body is too large\" try a smaller chunk
flashMessage	boolean	Send Flash SMS. (default: false) * refrain from using this in the call, if not used	optional
dlrState	string	Indicates if DLR will be sent. Acepted values: \"disabled\" - no DLR will be sent, \"all\" - will be send on success and failure, \"success\" - will be send only on success, \"failure\" - will be send only on failure.	required
isOTP	boolean	Defines is message is OTP message (priority rule would be affected). (default: false)	optional
isPremium	boolean	Flag which determines if message should be premium. (default: false)	optional
customSendId	string	Client custom send ID (from 3 up to 64 characters). The custom send ID will be present in response and DLR webhook. You can put only one custom send ID per request.	optional
delay	number	Defines message-sending startTime delay in seconds. Puts a message to the scheduler queue for sending in UTC.now + delay. Values: minimum: 1; maximum: 3600; default - 0. When using a delay parameter, isOTP parameter will be ignored.	optional
templateValues	object	Object with variables template values for each phone number in request payload.	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
responseCode	number	0 if success, not 0 otherwise
cost	number	Total cost for all messages.
sent	array	Messages ID with phone numbers array.

","urlObject":{"protocol":"https","path":["api","v1","message-send","personalized"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"23ef526a-cfc6-41e5-956e-226fb70cd8b0","name":"Personalized Message Send","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n\"message\": \"Hi [#customerName#], your OTP code is [#otpCode#]. This is [#someOtherKey#||defaultValue#] test\",\r\n \"from\": \"Source number example\",\r\n \"to\": [\r\n {\r\n \"phone\": \"+972552603210\",\r\n \"templateValues\": {\r\n \"customerName\": \"John\",\r\n \"otpCode\": \"1997\",\r\n \"someOtherKey\":\"1\"\r\n }},\r\n \r\n {\r\n \"phone\": \"+972552992023\",\r\n \"templateValues\": {\r\n \"customerName\": \"Tom\",\r\n \"otpCode\": \"2003\"\r\n }\r\n }\r\n ],\r\n\r\n \"flashMessage\": false, \r\n \"dlrState\": \"all\",\r\n \"isPremium\": false,\r\n \"isOTP\": true, \r\n \"delay\": 3600,\r\n \"customSendId\": \"CustomSendIdExample\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-send/personalized"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"37"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"118"},{"key":"Date","value":"Tue, 25 Oct 2022 14:19:27 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": 0,\n \"customSendId\": \"CustomSendIdExample\",\n \"cost\": 0.2,\n \"sent\": [\n {\n \"phone\": \"+972552603210\",\n \"messageId\": \"65253579a675ff7b7987b8d8\"\n },\n {\n \"phone\": \"+972552992023\",\n \"messageId\": \"65253579a675gg5e0b45b8d9\"\n }\n ]\n}"}],"_postman_id":"99f263ca-39cb-4d48-a0d2-bf88e923ed96"},{"name":"Message Status","id":"f5f33be2-6a37-49f1-bd35-c9d43c957b8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/message-status/{{message-id}}","description":"

This endpoint allows to get the status of one particular message; it allows you to use a GET request to retrieve the status of a message given its unique identifier (messageid). The response will include the status of the message, as well as the done date and any error codes associated with the message. The response is in the form of a JSON object containing the message id, status, done date, and error code.

possible status of the message :

prepared: in the process of being sent
\n
inqueue: in the process of being sent
\n
success: message handed over to the cellular operator , but simasti did not receive a status update if it was delivered or failed.
\n
failure: message was not delivered due to a failute ( either on Simasti or the cellular network. more info in the DLR.
\n
delivered : message was delivered successfuly
\n
blacklisted: simasti blocked this message because the number is in the black list.
\n
greylisted: sumasty blocked this message because the number is in the grey list
\n
insufficientbalance : you do not have sufficient balance to send this message.
\n

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Message ID.	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Message ID.
status	string	Message status. Possible values: prepared, inqueue, success, failure, delivered, blacklisted, greylisted, insufficientbalance
doneDate	string($date-time)	Date and time when the sent message reached a state (UTC timestamp).
errorCode	number	Reason for failure of message delivery. 0 if success.

","urlObject":{"protocol":"https","path":["api","v1","message-status","{{message-id}}"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"4649b877-78ac-42b9-b063-4905ac57f569","name":"Message Status","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/message-status/636a7de260bc71c0c142d8fe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"636a7de260bc71c0c142d8fe\",\n \"status\": \"success\",\n \"doneDate\": \"2022-11-08T16:03:48.460Z\",\n \"errorCode\": 0\n}"}],"_postman_id":"f5f33be2-6a37-49f1-bd35-c9d43c957b8e"},{"name":"Get Message","id":"417e7505-85af-49fb-bc70-ceba09b76e81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/get-message","description":"

/get-message enpoint allows to get messages by date range and receiver phone number

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
fromDate	string($date-time)	Return messages from specified date	required
toDate	string($date-time)	Return messages to specified date	required
phone	string	Receiver phone number with plus sign in international format	required
offset	number	Skip (offset) specified amount of items	optional
limit	number	Returned items limit	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
total	number	Total count of messages.
items	array	Messages array.
status	string	Message status. Possible values: prepared, inqueue, success, failure, delivered, blacklisted, greylisted, insufficientbalance
date	string($date-time)	Date on which returned messages were sent.
price	number	Price of message
errorCode	number	Reason for failure of message delivery. 0 if success.

","urlObject":{"protocol":"https","path":["api","v1","get-message"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"f30bd5a9-1a17-46fd-add8-ad5b78550b4f","name":"Get Message","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":{"raw":"https://my.simasti.com/api/v1/get-message?phone=+972521111111&fromDate=2022-02-02Z15:00:00+03:00&toDate=2022-02-02Z15:00:00+03:00","protocol":"https","host":["my","simasti","com"],"path":["api","v1","get-message"],"query":[{"key":"phone","value":"+972521111111"},{"key":"fromDate","value":"2022-02-02Z15:00:00+03:00"},{"key":"toDate","value":"2022-02-02Z15:00:00+03:00"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 0,\n \"items\": [\n {\n \"status\": \"prepared\",\n \"date\": \"2022-10-26T17:19:44.036Z\",\n \"price\": 0,\n \"errorCode\": 0\n }\n ]\n}"}],"_postman_id":"417e7505-85af-49fb-bc70-ceba09b76e81"},{"name":"Get Message by customSendId","id":"0ea36d12-5f8e-4363-b4b3-4dd05298d250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/get-message/by-custom-send-id?customSendId=exampleSendId","description":"

/get-message/by-custom-send-id enpoint allows to get messages by customSendId parameter that was passed when sending a message

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
customSendId	string	Client custom send ID (3 - 64 characters).	required
offset	number	Skip (offset) specified amount of items	optional
limit	number	Returned items limit	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
total	number	Total count of messages.
items	array	Messages array.
status	string	Message status. Possible values: prepared, inqueue, success, failure, delivered, blacklisted, greylisted, insufficientbalance
date	string($date-time)	Date on which returned messages were sent.
price	number	Price of message
errorCode	number	Reason for failure of message delivery. 0 if success.

","urlObject":{"protocol":"https","path":["api","v1","get-message","by-custom-send-id"],"host":["my","simasti","com"],"query":[{"key":"customSendId","value":"exampleSendId"}],"variable":[]}},"response":[{"id":"a9ae98ae-f290-4abd-818e-bd3fcc73f36f","name":"Get Message by customSendId","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://my.simasti.com/api/v1/get-message/by-custom-send-id?customSendId=exampleSendId","protocol":"https","host":["my","simasti","com"],"path":["api","v1","get-message","by-custom-send-id"],"query":[{"key":"customSendId","value":"exampleSendId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"items\": [\n {\n \"status\": \"delivered\",\n \"date\": \"2023-03-06T10:25:04.160Z\",\n \"price\": 0.007,\n \"errorCode\": 0,\n \"type\": \"sms\"\n },\n {\n \"status\": \"delivered\",\n \"date\": \"2023-03-06T10:25:28.304Z\",\n \"price\": 0.007,\n \"errorCode\": 0,\n \"type\": \"sms\"\n }\n ]\n}"}],"_postman_id":"0ea36d12-5f8e-4363-b4b3-4dd05298d250"}],"id":"8fdd19d2-fbf1-4233-aeb0-721ae9fa0f2c","description":"

With the help of the API, you can validate your message before sending, calculate its cost, send messages and check their info: status, failure reasons etc.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"70d273c2-1e56-47cc-8a53-234cc2700a17"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cbdf6920-98e4-45a2-adce-82827190872a"}}],"_postman_id":"8fdd19d2-fbf1-4233-aeb0-721ae9fa0f2c"},{"name":"MMS","item":[{"name":"Send MMS content","id":"b1c68b09-0bfe-48d9-a49b-2c6ed329419b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/Users/user/Documents/test.jpg"}]},"url":"https://my.simasti.com/api/v1/send-mms-content","description":"

Upload file to be sent in MMS message. Max size 2 MB. Returns URL that must be used with send-mms.

\n","urlObject":{"protocol":"https","path":["api","v1","send-mms-content"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"471ba425-9c51-4da2-9c66-390147ce9987","name":"Send MMS content","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","disabled":true}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/Users/user/Documents/test.jpg"}]},"url":"https://my.simasti.com/api/v1/send-mms-content"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://mogo.io/api/mms-content/test.jpg\"\n}"}],"_postman_id":"b1c68b09-0bfe-48d9-a49b-2c6ed329419b"},{"name":"Send MMS message","id":"71fbfac8-9898-4d6f-bf66-15ca8a478b7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"message\": \"This is test message.\",\n \"from\": \"Test\",\n \"to\": [\n \"+972521111111\",\n \"+972521112122\"\n ],\n \"dlrState\": \"success\",\n \"customSendId\": \"string\",\n \"isOTP\": true,\n \"contentLink\": \"https://my.simasti.com/api/mms-content/test.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/send-mms","description":"

Send MMS to phone numbers list. Before sending method perform paramters checks and validations. contentLink must contain URL of file uploaded using send-mms-content method

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
message	string	The text of the MMS.	required
from	string	Local phone number or Virtual number. Min length 3 bytes. Max length 11 bytes.	required
to	array	An array of up to 10,000 phone numbers with plus sign (international format).	required
dlrState	string	Indicates if DLR will be sent. Acepted values: \"disabled\" - no DLR will be send, \"all\" - will be send on success and failure, \"success\" - will be send only on success, \"failure\" - will be send only on failure.	required
isOTP	boolean	Defines is message is OTP message (priority rule would be affected). (default: false)	optional
contentLink	string	Flag which determines if message should be premium. (default: false)	optional
customSendId	string	Client custom send ID (from 3 up to 64 characters). The custom send ID will be present in response and DLR webhook. You can put only one custom send ID per request.	optional
contentLink	string	Must contain URL of file uploaded using send-mms-content method. example: https://mogo.io/api/mms-content/test.jpg	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
responseCode	number	0 if success, not 0 otherwise
cost	number	Total cost for all messages.
sent	array	Messages ID with phone numbers array.
customSendId	string	Client custom send ID.

","urlObject":{"protocol":"https","path":["api","v1","send-mms"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"44b8a563-abf0-4067-9863-ac1f3b8d5f5f","name":"Send MMS message","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","disabled":true}],"body":{"mode":"raw","raw":"{\n \"message\": \"This is test message.\",\n \"from\": \"Test\",\n \"to\": [\n \"+972521111111\",\n \"+972521112122\"\n ],\n \"dlrState\": \"success\",\n \"customSendId\": \"CustomId1\",\n \"isOTP\": true,\n \"contentLink\": \"https://mogo.io/api/mms-content/test.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/send-mms"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": 0,\n \"customSendId\": \"CustomId1\",\n \"cost\": 0.5,\n \"sent\": [\n {\n \"phone\": \"+972521111111\",\n \"messageId\": \"641bddf278d778ac0a62f9f1\"\n },\n {\n \"phone\": \"+972521112122\",\n \"messageId\": \"641bde178ddec2c6d875b63c\"\n }\n ]\n}"}],"_postman_id":"71fbfac8-9898-4d6f-bf66-15ca8a478b7a"}],"id":"d549b965-228c-494f-b054-8487e46dade7","_postman_id":"d549b965-228c-494f-b054-8487e46dade7","description":""},{"name":"Voice Message","item":[{"name":"Voice Message Send","id":"c0fce1f8-6eba-41f6-8163-49018f683791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message\": \"This is test message.\",\r\n \"from\": \"+972520000001\",\r\n \"to\": [\r\n \"+972521111111\",\r\n \"+972521112122\"\r\n ],\r\n \"dlrState\": \"all\",\r\n \"customSendId\": \"CustomSendId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/voice-message-send","description":"

This endpoint converts text message to voice and makes phone call to the list of numbers. Before sending, method performs parameters checks and validations. Field from always should be phone number in international format.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
message	string	The text of the message.	required
from	string	Virtual Number.	required
to	array	An array of up to 10,000 phone numbers with plus sign (international format).	required
dlrState	string	Indicates if DLR will be sent. Acepted values: \"disabled\" - no DLR will be send, \"all\" - will be send on success and failure, \"success\" - will be send only on success, \"failure\" - will be send only on failure.	required
customSendId	string	Client custom send ID (from 3 up to 64 characters). The custom send ID will be present in response and DLR webhook. You can put only one custom send ID per request.	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
responseCode	number	0 if success, not 0 otherwise
cost	number	Total cost for all messages.
sent	array	Messages ID with phone numbers array.
customSendId	String	the custom send ID set by you

","urlObject":{"protocol":"https","path":["api","v1","voice-message-send"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"1adcade6-b097-4bef-a363-3ba326c87a8a","name":"Voice Message Send","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"message\": \"This is test message.\",\r\n \"from\": \"+972520000001\",\r\n \"to\": [\r\n \"+972521111111\",\r\n \"+972521112122\"\r\n ],\r\n \"dlrState\": \"all\",\r\n \"customSendId\": \"CustomSendId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/voice-message-send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": 0,\n \"customSendId\": \"CustomSendId1\",\n \"cost\": 0.11,\n \"sent\": [\n {\n \"phone\": \"+972521111111\",\n \"messageId\": \"641c2fd7d62526ff9a0231e2\"\n },\n {\n \"phone\": \"+972521112122\",\n \"messageId\": \"641c2ff150a0d3c4be3c8e84\"\n }\n ]\n}"}],"_postman_id":"c0fce1f8-6eba-41f6-8163-49018f683791"}],"id":"33796633-57c6-4c94-8e13-a2a54a6d162c","_postman_id":"33796633-57c6-4c94-8e13-a2a54a6d162c","description":""},{"name":"Black List","item":[{"name":"Get blacklisted numbers","event":[{"listen":"test","script":{"id":"e42263df-156f-4abc-976b-924ac619b4e5","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"a0fda5cf-631b-4bf6-b62c-92c79627996e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/black-list","description":"

This endpoint allows to get all blacklisted phone numbers.
Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
sortBy	string	country, phone or reason	optional
sortOrder	string	Sort order (ascending by default). Available values: ASC, DESC	optional
offset	number	Skip (offset) specified amount of items	optional
limit	number	Returned items limit. Default value : 10	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
total	number	Total count of numbers in the list
items	array	Blacklisted items array
id	string	Item ID Internal simasti ID. share in case you turn to support
phone	string	Phone number
country	string	Country ISO 3166-1 alpha2 code
reason	string	Reason for blacklisting

","urlObject":{"protocol":"https","path":["api","v1","black-list"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"d3b3aaa4-cabe-4755-be8f-644b7dcf6ecc","name":"Black list","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/black-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"13"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"111"},{"key":"Date","value":"Tue, 25 Oct 2022 15:00:01 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"items\": [\n {\n \"country\": \"IL\",\n \"phone\": \"972552603210\",\n \"reason\": \"some reason\",\n \"id\": \"634ffe8729a980349dfc71c1\"\n }\n ]\n}"}],"_postman_id":"a0fda5cf-631b-4bf6-b62c-92c79627996e"},{"name":"Add number to black list","event":[{"listen":"test","script":{"id":"e42263df-156f-4abc-976b-924ac619b4e5","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"b4981043-3876-4a65-8e15-e1b4cdf05b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phone\": \"string\",\n \"reason\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/black-list","description":"

This endpoint allows to add some specific number to the black list.
Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
phone	string	Phone number in international format that you need to add to clack list.	required
reason	string	Some text with reason of adding this number to black list.	required

","urlObject":{"protocol":"https","path":["api","v1","black-list"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"a87a38f9-fd8f-4513-9613-f1bc30398803","name":"Add number to black list","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"phone\": \"+972552603210\",\n \"reason\": \"Some reason\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/black-list"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b4981043-3876-4a65-8e15-e1b4cdf05b05"},{"name":"Delete number from the black list","event":[{"listen":"test","script":{"id":"e42263df-156f-4abc-976b-924ac619b4e5","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"d936a487-a1b3-411f-9343-b115a35aac12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"phone\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/black-list","description":"

This endpoint allows to delete some specific number from the black list.
Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
phone	string	Phone number in international format that you need to delete from the balck list.	required

","urlObject":{"protocol":"https","path":["api","v1","black-list"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"d89339a6-2c3b-43a3-b5b5-6e9ea8ac107b","name":"Delete number from the black list","originalRequest":{"method":"DELETE","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"phone\": \"+972552603210\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/black-list"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d936a487-a1b3-411f-9343-b115a35aac12"},{"name":"Import Blacklist CSV","event":[{"listen":"test","script":{"id":"e42263df-156f-4abc-976b-924ac619b4e5","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"161da3f3-54eb-459a-993c-909944e70acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/Users/marinalatysh/Downloads/person1.csv"}]},"url":"https://my.simasti.com/api/v1/black-list/import?phoneIndex=1&reasonIndex=3&countryIndex=2&delimiter=;","description":"

This endpoint allows to import Blacklist CSV up to 1 milion records. Accepts text/csv file in utf-8 encoding. Expected table header on first record.
Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
delimiter	query	Delimiter which used in the row. Example : ;	required
countryIndex	query	Index of the country in the row after parsing csv by delimiter.	optional
reasonIndex	query	Index of the reason in the row after parsing csv by delimiter.	optional
phoneIndex	query	Index of the phone in the row after parsing csv by delimiter.	required
import	file (formData)	text/csv file in utf-8 encoding	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
recordsParsed	number	Total count of parsed records
inserted	number	Amount of numbers that were added to black list
skipped	number	Amount of skipped records in the file
duplicated	number	Amount of records that already exist in system

","urlObject":{"protocol":"https","path":["api","v1","black-list","import"],"host":["my","simasti","com"],"query":[{"key":"phoneIndex","value":"1"},{"key":"reasonIndex","value":"3"},{"key":"countryIndex","value":"2"},{"key":"delimiter","value":";"}],"variable":[]}},"response":[{"id":"65151ac3-67e6-4fd4-b149-40efda393d28","name":"Import Blacklist CSV","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876"}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/Users/user/Downloads/ExampleData.csv"}]},"url":{"raw":"https://my.simasti.com/api/v1/black-list/import?phoneIndex=1&countryIndex=2&reasonIndex=3&delimiter=;","protocol":"https","host":["my","simasti","com"],"path":["api","v1","black-list","import"],"query":[{"key":"phoneIndex","value":"1"},{"key":"countryIndex","value":"2"},{"key":"reasonIndex","value":"3"},{"key":"delimiter","value":";"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"recordsParsed\": 6,\n \"inserted\": 3,\n \"skipped\": 1,\n \"duplicated\": 2\n}"}],"_postman_id":"161da3f3-54eb-459a-993c-909944e70acc"},{"name":"Grey list","event":[{"listen":"test","script":{"id":"f1a14125-1a1f-4a12-bb55-2e13eaeed85c","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"30744bd0-b26d-43d9-89e8-f446029fb5d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-mogo-account-id","value":"","type":"text"}],"url":"https://my.simasti.com/api/v1/grey-list","description":"

OBSOLETE

~~Get greylisted phone numbers.~~

~~Request parameters:~~

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

~~Parameter~~	~~Type~~	~~Value~~
~~sortBy~~	~~string~~	~~Sort by column with provided name~~	~~optional~~
~~sortOrder~~	~~string~~	~~Sort order (ascending by default). Available values: ASC, DESC~~	~~optional~~
~~offset~~	~~number~~	~~Skip (offset) specified amount of items~~	~~optional~~
~~limit~~	~~number~~	Returned items limit. Default value: 10	~~optional~~

~~Response parameters:~~

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

~~Parameter~~	~~Type~~	~~Value~~
~~total~~	~~number~~	~~Total count of numbers in the list~~
~~items~~	~~array~~	~~Blacklisted items array~~
id	~~string~~	~~Item ID~~
~~phone~~	~~string~~	~~Phone number~~
~~country~~	~~string~~	~~Country ISO 3166-1 alpha2 code~~
~~reason~~	~~string~~	~~Reason for greylisting~~

","urlObject":{"protocol":"https","path":["api","v1","grey-list"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"32bf7983-a977-4b07-83d3-0b6fc25aceab","name":"Grey list","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/grey-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"39"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"22"},{"key":"Date","value":"Tue, 25 Oct 2022 15:02:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"items\": [\n {\n \"country\": \"IL\",\n \"phone\": \"972552603000\",\n \"reason\": \"some reason\",\n \"id\": \"634ffe8729a980349dfc87b4\"\n }\n ]\n}"}],"_postman_id":"30744bd0-b26d-43d9-89e8-f446029fb5d9"},{"name":"Get stop words","event":[{"listen":"test","script":{"id":"26887962-1d1f-499a-9a06-9f835870aadd","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"ad14251a-6d70-47ce-87ff-a320ce69a5c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/stop-word","description":"

Get all stop words list. When a client sends a stop word from the phone, their number is added to the black list.

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
total	number	Total amount of stop words
items	array	Stop words array
id	string	Item ID
word	string	Stop word value

","urlObject":{"protocol":"https","path":["api","v1","stop-word"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"d641e736-abd7-4b41-9abb-ae5d05d4d709","name":"Get stop words","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/stop-word"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"3"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"79"},{"key":"Date","value":"Tue, 25 Oct 2022 18:02:32 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"items\": [\n {\n \"word\": \"some stop word\",\n \"id\": \"63582499b82af2b7a4977d34\"\n }\n ]\n}"}],"_postman_id":"ad14251a-6d70-47ce-87ff-a320ce69a5c4"}],"id":"ffd1532d-639d-4b69-83d3-7594695d2873","description":"

Black list is a list of numbers which is blocked from being sent in Simasti. the reasons for adding a number to this list can be because the recipient asked not to receive any sms from you, or because SImasti identified this number as a risk, and blocks it across the whole Simasti client range ( hence, message to this number wont be delivered for ANY of simasti's clients ).

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7cae8f50-16fc-4a6e-9595-b347cdeee693"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e7a6718e-84b7-4813-8bae-bd639c0bd592"}}],"_postman_id":"ffd1532d-639d-4b69-83d3-7594695d2873"},{"name":"Stop words and ubsubscribe","item":[{"name":"Add stop word","event":[{"listen":"test","script":{"id":"5788612d-8cb9-4814-8acb-85095b5396c9","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"7f09ac6a-44be-4705-b594-f8ad66a0d1a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"word\": \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/stop-word","description":"

Add one stop word to stop words list. Possible up to 100 words.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
word	string	New stop word value	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Id of created stop word

","urlObject":{"protocol":"https","path":["api","v1","stop-word"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"f58dae20-6b00-4176-9bb3-e8d132dddc69","name":"Add stop word","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"word\": \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/stop-word"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"118"},{"key":"x-ratelimit-reset","value":"52"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"33"},{"key":"Date","value":"Tue, 25 Oct 2022 18:04:47 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6358253fb82af2b7a4977d40\"\n}"}],"_postman_id":"7f09ac6a-44be-4705-b594-f8ad66a0d1a5"},{"name":"Edit stop word","event":[{"listen":"test","script":{"id":"d38cf280-d1d0-4aeb-a9a3-ab845ad78f8c","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"c80ce8e5-381c-4f26-865a-7686294c9a6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"word\": \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/stop-word/{{stopword-id}}","description":"

Change one stop word value.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
word	string	New stop word value	required
id	string	Stop word id	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Stop word id
word	string	New stop word value

","urlObject":{"protocol":"https","path":["api","v1","stop-word","{{stopword-id}}"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"fbf3445d-b248-4e7d-a217-eebbb945e72e","name":"Edit stop word","originalRequest":{"method":"PATCH","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"word\": \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/stop-word/6358253fb82af2b7a4977d40"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"21"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"50"},{"key":"Date","value":"Tue, 25 Oct 2022 18:07:09 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6358253fb82af2b7a4977d40\",\n \"word\": \"example\"\n}"}],"_postman_id":"c80ce8e5-381c-4f26-865a-7686294c9a6c"},{"name":"Delete stop word","event":[{"listen":"test","script":{"id":"ef2bed9e-8e05-4732-8b5d-8efc1720d4a2","exec":["pm.test(\"Status is 200 ok, response is json\", function () {\r"," pm.response.to.have.status(200);\r"," pm.response.to.be.ok; \r"," pm.response.to.be.withBody;\r"," pm.response.to.be.json; \r","});\r","\r","let schema = {\r"," \"properties\": {\r"," \"total\": {\"type\": \"integer\"},\r"," \"receivers\": {\"type\": \"array\", \r"," \"items\": {\"type\": \"object\"}, \r"," \"properties\": {\r"," \"id\": {\"type\": \"string\"},\r"," \"phone\": {\"type\": \"string\"},\r"," \"country\": {\"type\": \"string\"},\r"," \"reason\": {\"type\": \"string\"},\r"," }, \r"," },\r","} };\r","\r","pm.test('Schema is valid', function() {\r"," pm.response.to.have.jsonSchema(schema);\r","});"],"type":"text/javascript","packages":{}}}],"id":"a783e0db-4258-46d3-9259-7d5dc16788db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/stop-word/{{stopword-id}}","description":"

Remove one stop word from stop words list.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Stop word id	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Stop word id

SImasti offers you the ability to \"ubsubscribe\" your customers from the sending list. this can be done in 2 different ways:

by adding an ubsubscribe link to your message body (used in the client Portal )
\n
by allowing your customer to reply to the sms you've sent. ( to a virtual number you've aquired from SImasti ) with a word that you identify as unsubscribe word, such as \"STOP\", ״הסר״ etc. you can have multiple stop words. once your customer replies to the virtual number, the system will add this number to your black list, and from that moment, marketing SMS will not be sent to this recipient.
\n

\n","_postman_id":"52dad6b4-cd09-41f3-9eba-3410753d42e9"},{"name":"Balance","item":[{"name":"Get balance","id":"b9cec657-a7d9-470f-964a-93033fbedff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/balance","description":"

With this API, the Client can submit an authenticated request and receive a response showing the number of Credits currently available on that account/sub-account.
Number of credits available may not be a whole number
Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
currency	string	Client currency. ISO 4217 alpha3 code
balance	number	Current client balance.

","urlObject":{"protocol":"https","path":["api","v1","balance"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"ebc1539f-36dc-441a-a554-c449673966f9","name":"Get balance","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"118"},{"key":"x-ratelimit-reset","value":"21"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"Date","value":"Tue, 25 Oct 2022 15:05:37 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"currency\": \"ILS\",\n \"balance\": 94\n}"}],"_postman_id":"b9cec657-a7d9-470f-964a-93033fbedff4"},{"name":"Balance History","id":"8757fa94-273c-4a1f-818a-037e8539376e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/balance/history","description":"

Get balance changes history for client.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
sortBy	string	Sort by column with provided name	optional
sortOrder	string	Sort order (ascending by default). Available values: ASC, DESC	optional
offset	number	Skip (offset) specified amount of items	optional
limit	number	Returned items limit. Default value : 10	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
total	number	Total count of items in the list
items	array	Balance history items array
month	number	Month when balance was changed
type	string	Operation type. Possible values: debit, credit
threshold	string	Client threshold value at transaction moment
amount	number	Client transaction amount
currency	string	Transaction currency (ISO 4217 alpha3 code)
balanceBefore	number	Balance before transaction
balanceAfter	number	Balance after transaction
createdAt	string($date-time)	Item creation timestamp

","urlObject":{"protocol":"https","path":["api","v1","balance","history"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"1d6a8551-c12f-47b3-b991-853d05dbe0b6","name":"Balance History","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/balance/history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"21"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1598"},{"key":"Date","value":"Tue, 25 Oct 2022 15:08:28 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"items\": [\n \n {\n \"month\": 1664582400000,\n \"type\": \"debit\",\n \"threshold\": 0,\n \"amount\": 2,\n \"currency\": \"ILS\",\n \"balanceBefore\": 6,\n \"balanceAfter\": 4,\n \"createdAt\": \"2022-10-05T12:20:22.831Z\"\n },\n {\n \"month\": 1664582400000,\n \"type\": \"debit\",\n \"threshold\": 0,\n \"amount\": 2,\n \"currency\": \"ILS\",\n \"balanceBefore\": 4,\n \"balanceAfter\": 2,\n \"createdAt\": \"2022-10-05T12:20:42.096Z\"\n }\n ]\n}"}],"_postman_id":"8757fa94-273c-4a1f-818a-037e8539376e"},{"name":"Balance credits history","id":"7c1f74af-0028-472b-93fe-325be0dbd0f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/balance/credits/history","description":"

Get balance changes history for client.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
sortBy	string	Sort by column with provided name	optional
sortOrder	string	Sort order (ascending by default). Available values: ASC, DESC	optional
offset	number	Skip (offset) specified amount of items	optional
limit	number	Returned items limit. Default value : 10	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
total	number	Total count of items in the list
items	array	Balance history items array
month	number	Month when balance was changed
type	string	Operation type. Possible values: debit, credit
threshold	string	Client threshold value at transaction moment
amount	number	Client transaction amount
currency	string	Transaction currency (ISO 4217 alpha3 code)
balanceBefore	number	Balance before transaction
balanceAfter	number	Balance after transaction
createdAt	string($date-time)	Item creation timestamp

","urlObject":{"protocol":"https","path":["api","v1","balance","credits","history"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"479de257-88ee-48f6-91d0-591f83a30999","name":"Balance History","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/balance/history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"117"},{"key":"x-ratelimit-reset","value":"21"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1598"},{"key":"Date","value":"Tue, 25 Oct 2022 15:08:28 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 0,\n \"items\": [\n {\n \"id\": \"string\",\n \"balance\": 0,\n \"alertThreshold\": 0,\n \"country\": \"string\",\n \"encoding\": \"ascii7\",\n \"type\": \"sms\",\n \"charPerCredit\": 0\n }\n ]\n}"}],"_postman_id":"7c1f74af-0028-472b-93fe-325be0dbd0f8"},{"name":"Check message cost","id":"17195766-250c-4cea-88f9-6c51271dedfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message\": \"tenetur perspiciatis quia\",\r\n \"country\": \"IL\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/balance/check-message","description":"

Validate message and calculate it price for specified country. Method calculate SMS count and total price per one phone number.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
country	string	Country ISO 3166-1 alpha2 code	required
message	string	Checked message text	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
price	number	Total messages price
messages	array	Splitted message to SMS messages array

","urlObject":{"protocol":"https","path":["api","v1","balance","check-message"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"df2824c0-fb8f-4c70-aa24-e204f2a096e6","name":"Check message cost","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"message\": \"some text of message\",\r\n \"country\": \"IL\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/balance/check-message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"115"},{"key":"x-ratelimit-reset","value":"53"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"48"},{"key":"Date","value":"Tue, 25 Oct 2022 15:11:27 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"some text of message\"\n ],\n \"price\": 2\n}"}],"_postman_id":"17195766-250c-4cea-88f9-6c51271dedfd"}],"id":"d03d580d-0d2e-48e9-aaa5-fb2b66958ef8","description":"

Please note: for accounts that are configured with credits, please use the

extention /crecdits:

https://mogo.io/api/v1/balance/credits

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c7852fb9-a1bc-4e01-ba07-7f138ce7af2b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0292f326-c721-42bb-9d84-c905e380371d"}}],"_postman_id":"d03d580d-0d2e-48e9-aaa5-fb2b66958ef8"},{"name":"Reporting","item":[{"name":"Messages statistic","id":"82ab724b-dac9-4d51-881e-e5432db57bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/report/message/statistic","description":"

Get client messages statistic report.

\n","urlObject":{"protocol":"https","path":["api","v1","report","message","statistic"],"host":["my","simasti","com"],"query":[{"disabled":true,"key":"take","value":"10"},{"disabled":true,"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"069dc688-4b04-4480-96e1-8b4a013b3661","name":"Messages statistic","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":{"raw":"https://my.simasti.com/api/v1/report/message/statistic","protocol":"https","host":["my","simasti","com"],"path":["api","v1","report","message","statistic"],"query":[{"key":"take","value":"10","disabled":true},{"key":"offset","value":"0","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"119"},{"key":"x-ratelimit-reset","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"110"},{"key":"Date","value":"Tue, 25 Oct 2022 17:49:47 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"smsQnt\": 0,\n \"messageQnt\": 15,\n \"status\": \"delivered\"\n },\n {\n \"smsQnt\": 0,\n \"messageQnt\": 4,\n \"status\": \"insufficientbalance\"\n }\n]"}],"_postman_id":"82ab724b-dac9-4d51-881e-e5432db57bba"},{"name":"Report","id":"6c82302c-4156-4b37-b746-6437bfe0463e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/report/messages?startDate=2022-08-14T01:15:43.861&endDate=2022-08-14T23:15:43.861&groupBy=status","description":"

Get client account report about sended messages.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
startDate	string($date-time)	Start date. If timezone omited - used UTC. Example : 2022-02-02Z15:00:00+03:00	required
endDate	string($date-time)	End date. If timezone omited - used UTC. Example : 2022-02-03Z15:00:00+03:00	required
groupBy	array[string]	Group by keys (one or several). Available values : status, createdAt, client, sellPrice, buyPrice, messageLength, campaign	required
offset	number	Skip (offset) items	optional
limit	number	Returned items limit.	optional
clientPrice	number	Buy price filter	optional
campaign	string	Campaign id filter	optional
status	string	Message status filter. Available values : prepared, inqueue, success, failure, delivered, blacklisted, greylisted, insufficientbalance	optional
createdAt	string($date-time)	Messages created time filter	optional

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
data	array	Array of report entries
country	string	Country ISO 3166-1 alpha2 code
smsQnt	number	SMS count
messageQnt	number	Messages count
date	string	Sent date
totalBuyPrice	number	Total buy price
buyPrice	number	Buy price per one message
status	string	Message status. Possible values: prepared, inqueue, success, failure, delivered, blacklisted, greylisted, insufficientbalance

","urlObject":{"protocol":"https","path":["api","v1","report","messages"],"host":["my","simasti","com"],"query":[{"key":"startDate","value":"2022-08-14T01:15:43.861"},{"key":"endDate","value":"2022-08-14T23:15:43.861"},{"key":"groupBy","value":"status"}],"variable":[]}},"response":[{"id":"e051d665-c964-4a26-aa24-1aaa258ef705","name":"Report","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":{"raw":"https://my.simasti.com/api/v1/report/messages?startDate=2022-08-14T01:15:43.861&endDate=2022-08-14T23:15:43.861&groupBy=status&offset=0&limit=100","protocol":"https","host":["my","simasti","com"],"path":["api","v1","report","messages"],"query":[{"key":"startDate","value":"2022-08-14T01:15:43.861"},{"key":"endDate","value":"2022-08-14T23:15:43.861"},{"key":"groupBy","value":"status"},{"key":"offset","value":"0"},{"key":"take","value":"10","disabled":true},{"key":"limit","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"118"},{"key":"x-ratelimit-reset","value":"59"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"73"},{"key":"Date","value":"Tue, 25 Oct 2022 17:53:19 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 5,\n \"date\": \"19/08/2022 09:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 100,\n \"status\": \"success\"\n },\n {\n \"country\": \"UA\",\n \"smsQnt\": 0,\n \"messageQnt\": 0,\n \"date\": \"27/07/2022 11:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 0,\n \"status\": \"failure\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 5,\n \"date\": \"23/08/2022 12:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 100,\n \"status\": \"success\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 96,\n \"date\": \"23/08/2022 01:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 480,\n \"status\": \"failure\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 96,\n \"date\": \"23/08/2022 01:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 480,\n \"status\": \"success\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 24,\n \"date\": \"23/08/2022 12:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 240,\n \"status\": \"success\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 8,\n \"date\": \"18/08/2022 10:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 80,\n \"status\": \"success\"\n },\n {\n \"country\": \"UA\",\n \"smsQnt\": 0,\n \"messageQnt\": 0,\n \"date\": \"26/07/2022 11:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 0,\n \"status\": \"failure\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 16,\n \"date\": \"23/08/2022 12:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 80,\n \"status\": \"success\"\n },\n {\n \"country\": \"IL\",\n \"smsQnt\": 0,\n \"messageQnt\": 144,\n \"date\": \"23/08/2022 11:00:00\",\n \"totalBuyPrice\": 0,\n \"buyPrice\": 480,\n \"status\": \"success\"\n }\n ],\n \"total\": 10,\n \"info\": {\n \"available\": 749,\n \"inProgress\": 0,\n \"toCreate\": 0\n }\n}"}],"_postman_id":"6c82302c-4156-4b37-b746-6437bfe0463e"},{"name":"KPI","id":"2a34e3ab-45b0-4140-9a5b-7d930a4a8e79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/kpi","description":"

Get Client KPI (key performance indicators): sent messages quantity, average message size, aggregated per status, currency.

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
lastUpdate	string($date-time)	Last information update timestamp
timeframe	number	Time period for collected data in minutes
totalMessageSent	array	Information about quantity and cost for sent messages per status (grouped by currency)
currency	string	Grouped by currency. Key in ISO 4217 alpha3 code
groupByStatus		Information about quantity and cost for sent messages per status
status	string	Message status. Available values: prepared, inqueue, success, failure, delivered, blacklisted, greylisted, insufficientbalance
buyPrice	number	Message buy price
averageMessageSize		Average message (not SMS) body size
encoding	string	Message encoding array. Possible values: ascii7, ascii8, utf8
smsQuantity	number	SMS quantity
messageQuantity	number	Messages quantity
averageSize	number	Average message size in characters

","urlObject":{"protocol":"https","path":["api","v1","kpi"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"81115c56-7054-4ba0-bb8b-406d26f57c8a","name":"KPI","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/kpi"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';style-src 'self' 'unsafe-inline';img-src self' 'data:' 'validator.swagger.io';script-src 'self' https: 'unsafe-inline';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';object-src 'none';script-src-attr 'none';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-origin-resource-policy","value":"cross-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-ratelimit-limit","value":"120"},{"key":"x-ratelimit-remaining","value":"118"},{"key":"x-ratelimit-reset","value":"41"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"812"},{"key":"Date","value":"Tue, 25 Oct 2022 17:58:02 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"lastUpdate\": \"2022-10-24T09:10:00.008Z\",\n \"timeframe\": 600,\n \"totalMessageSent\": [\n {\n \"currency\": \"ILS\",\n \"groupByStatus\": [\n {\n \"status\": \"prepared\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"inqueue\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"success\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"failure\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"delivered\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"blacklisted\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"greylisted\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n },\n {\n \"status\": \"insufficientbalance\",\n \"messageQuantity\": 0,\n \"buyPrice\": 0\n }\n ]\n }\n ],\n \"averageMessageSize\": [\n {\n \"encoding\": \"ascii7\",\n \"smsQuantity\": 0,\n \"messageQuantity\": 0,\n \"averageSize\": 0\n },\n {\n \"encoding\": \"ascii8\",\n \"smsQuantity\": 0,\n \"messageQuantity\": 0,\n \"averageSize\": 0\n },\n {\n \"encoding\": \"utf8\",\n \"smsQuantity\": 0,\n \"messageQuantity\": 0,\n \"averageSize\": 0\n }\n ]\n}"}],"_postman_id":"2a34e3ab-45b0-4140-9a5b-7d930a4a8e79"}],"id":"941836f3-6849-4bc9-9be4-b6d2f11e22b0","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"17c2fc83-cad9-487a-bb78-df12842419d8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8b177e01-1730-4c26-8e82-57ee16c4a03e"}}],"_postman_id":"941836f3-6849-4bc9-9be4-b6d2f11e22b0","description":""},{"name":"Contact list","item":[{"name":"Get available contact lists","id":"6c92c789-3135-48af-b32c-7b0811ddf480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list","description":"

This enpoint returns list of all available contact lists for client.

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Contact list ObjectId
name	string	Name of the Contact list
createdAt	$date-time	Date and time of when Contact list was created
numberOfContacts	number	Amount of phone numbers contained in contact list

","urlObject":{"protocol":"https","path":["api","v1","contact-list"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"7f40b603-ebb7-49cd-b626-da81fd4915ad","name":"Get available contact lists","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"lists\": [\n {\n \"id\": \"641c263d39cfb18e20a0b340\",\n \"name\": \"ContactList1\",\n \"createdAt\": \"2023-03-23T10:11:54.670Z\",\n \"numberOfContacts\": 123\n }\n ],\n \"total\": 1\n}"}],"_postman_id":"6c92c789-3135-48af-b32c-7b0811ddf480"},{"name":"Get contact list data","id":"76eac0b6-8a47-4235-a4bd-ffa80df33871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list/{{contactList_id}}","description":"

Returns general data about one specific contact list

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Contact list ObjectId
name	string	Name of the Contact list
createdAt	$date-time	Date and time of when Contact list was created
numberOfContacts	number	Amount of phone numbers contained in contact list

","urlObject":{"protocol":"https","path":["api","v1","contact-list","{{contactList_id}}"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"44d3c6f1-844c-4d07-b1f1-e0edf7e2d283","name":"Get contact list data","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list/641c263d39cfb18e20a0b340"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"641c263d39cfb18e20a0b340\",\n \"name\": \"ContactList1\",\n \"createdAt\": \"2023-03-23T10:18:13.115Z\",\n \"numberOfContacts\": 123\n}"}],"_postman_id":"76eac0b6-8a47-4235-a4bd-ffa80df33871"},{"name":"Import contact list","id":"cb46a60f-1c3a-4e04-8ae0-df97f06bb04b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/C:/Users/user/Desktop/222.csv"}]},"url":"https://my.simasti.comapi/v1/contact-list/import?skipHeader=true","description":"

If import mapping was not saved return initial 5 records and available mapping. Accept text/csv file in utf-8 encoding. Expected table header on first record. Expected delimiter \";\"

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
skipHeader	query, boolean	Specifies if imported CSV file contains header. Put true to skip header, false - to include first line to contact list	required
import	file	CSV file with up to 1M records	required

","urlObject":{"protocol":"https","path":["v1","contact-list","import"],"host":["my","simasti","comapi"],"query":[{"key":"skipHeader","value":"true"}],"variable":[]}},"response":[{"id":"76d8b782-2de2-400a-bf8e-4145e3a51fc7","name":"Import contact list","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"","disabled":true}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/C:/Users/user/Desktop/222.csv"}]},"url":{"raw":"https://my.simasti.com/api/v1/contact-list/import?skipHeader=true","protocol":"https","host":["my","simasti","com"],"path":["api","v1","contact-list","import"],"query":[{"key":"skipHeader","value":"true"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cb46a60f-1c3a-4e04-8ae0-df97f06bb04b"},{"name":"Re-import contact list","id":"5ad79715-2275-4cf3-8a46-1fd2d0a98414","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/C:/Users/user/Desktop/222.csv"}]},"url":"https://my.simasti.com/api/v1/contact-list/641c263d39cfb18e20a0b340/import?skipHeader=true","description":"

If import mapping was not saved return initial 5 records and available mapping. Accept text/csv file in utf-8 encoding. Expected table header on first record. Expected delimiter \";\"

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Contact list Object Id	required
skipHeader	query, boolean	Specifies if imported CSV file contains header. Put true to skip header, false - to include first line to contact list	required
import	file	CSV file with up to 1M records	required

","urlObject":{"protocol":"https","path":["api","v1","contact-list","641c263d39cfb18e20a0b340","import"],"host":["my","simasti","com"],"query":[{"key":"skipHeader","value":"true"}],"variable":[]}},"response":[{"id":"96923d46-9fef-4943-a909-8b7e579128bd","name":"Re-import contact list","originalRequest":{"method":"PATCH","header":[{"key":"x-mogo-account-id","value":"","disabled":true}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"import","src":"/C:/Users/user/Desktop/222.csv"}]},"url":{"raw":"https://my.simasti.com/api/v1/contact-list/641c263d39cfb18e20a0b340/import?skipHeader=true","protocol":"https","host":["my","simasti","com"],"path":["api","v1","contact-list","641c263d39cfb18e20a0b340","import"],"query":[{"key":"skipHeader","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5ad79715-2275-4cf3-8a46-1fd2d0a98414"},{"name":"Add mapping pattern","id":"66d95fc2-e965-4eff-b643-c4d21edc855c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"phone\": {\r\n \"index\": 0\r\n },\r\n \"fileName\": \"string\",\r\n \"description\": {\r\n \"index\": 0\r\n },\r\n \"metadata\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list/import/mapping","description":"

This enpoint imports expected metadata mapping pattern based on imported CSV file name.

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
phone	object	Client contact book phone number.	required
index	number	Position of the element in the array	required
fileName	string	Name of file to make mapping for	required
description	object	Client contact book description	required
index	number	Position of element in the array	required
metadata	array	Client metadata	required

","urlObject":{"protocol":"https","path":["api","v1","contact-list","import","mapping"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"84213a86-c434-491f-9ea7-82308f83d178","name":"Add mapping pattern","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"phone\": {\r\n \"index\": 0\r\n },\r\n \"fileName\": \"test.csv\",\r\n \"description\": {\r\n \"index\": 1\r\n },\r\n \"metadataName\": {\r\n \"index\": 2\r\n },\r\n \"metadata\": [\r\n \"metadataName\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list/import/mapping"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"66d95fc2-e965-4eff-b643-c4d21edc855c"},{"name":"Get available mapping","id":"157e8cf4-2959-4547-af61-93b64f12ec48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/contact-list/import/mapping","description":"

Returns list of client's mappings

\n","urlObject":{"protocol":"https","path":["v1","contact-list","import","mapping"],"host":["my","simasti","comapi"],"query":[],"variable":[]}},"response":[],"_postman_id":"157e8cf4-2959-4547-af61-93b64f12ec48"},{"name":"Delete available mapping by ID","id":"e6708669-b040-44cf-a21c-a2ee51a31ac8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/contact-list/import/mapping/{id}","description":"

Remove client's mapping by mapping ID

\n","urlObject":{"protocol":"https","path":["v1","contact-list","import","mapping","{id}"],"host":["my","simasti","comapi"],"query":[],"variable":[]}},"response":[{"id":"cf98f748-462f-48dc-ac92-934d53cf4d54","name":"Delete available mapping by ID","originalRequest":{"method":"DELETE","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list/import/mapping/641c2d97074c8df9b94f84f1"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e6708669-b040-44cf-a21c-a2ee51a31ac8"},{"name":"Change contact list name","id":"8a0d8b93-6f25-43f1-a856-7d0cf99324e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/contact-list/{{contactList_Id}}","description":"

Update name of contact list

\n","urlObject":{"protocol":"https","path":["v1","contact-list","{{contactList_Id}}"],"host":["my","simasti","comapi"],"query":[],"variable":[]}},"response":[{"id":"f30b33ea-20e3-4ad4-b17c-e8f344d52ef9","name":"Change contact list name","originalRequest":{"method":"PATCH","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"name\": \"New name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/contact-list/641c2e72aed13065cb89f1e6"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8a0d8b93-6f25-43f1-a856-7d0cf99324e0"}],"id":"4c6f6216-162b-4d9a-aac9-d936777b507c","_postman_id":"4c6f6216-162b-4d9a-aac9-d936777b507c","description":""},{"name":"Campaign","item":[{"name":"Send campaign messages","id":"8c8d4a63-8ca3-4f28-8103-00a38c998c15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"messageTemplate\": \"string\",\r\n \"source\": \"string\",\r\n \"type\": \"sms\",\r\n \"customSendId\": \"string\",\r\n \"contactListIds\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/campaign/send","description":"

Creates campaign with provided contact lists, sets sendDateTimeUtc parameter to current datetime UTC - 1 second

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
name	string	Name of the campaign	required
messageTemplate	string	Message template with user metadata like [#metadataName#] - the body of the message	required
source	string	Source of the messages campaign	required
type	string	Message type which will be sent. Possible values: sms, flash-sms, sms-answer, mms, voice_message, email, premium-message	required
customSendId	string	Client custom send ID of up to 64 characters. The custom send ID will be present in DLR webhook. You can put only one custom send ID per request.	optional
contactListIds	array[string]	Array of contact list ids to be used in campaign	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Message campaign id
status	string	Message campaign status
messageQnt	number	Toral amount of messages in campaign
messageQueuedQnt	number	Total amount of queued messages in campaign

","urlObject":{"protocol":"https","path":["api","v1","campaign","send"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"6b0e1315-9063-4604-a5c5-1344903fff93","name":"Send campaign messages","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Some campaign name\",\r\n \"messageTemplate\": \"[#metadata#] message text\",\r\n \"source\": \"Sender name\",\r\n \"type\": \"sms\",\r\n \"customSendId\": \"CustomId2\",\r\n \"contactListIds\": [\r\n \"641c2231a0870e33a18dfb10\", \"641c223ee153b414ce8df033\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/campaign/send"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"633d7ef6c9745250ed7367b3\",\n \"status\": \"created\",\n \"messageQnt\": 123,\n \"messageQueuedQnt\": 34\n}"}],"_postman_id":"8c8d4a63-8ca3-4f28-8103-00a38c998c15"},{"name":"Send campaign test message","id":"6e7249ad-1269-4d74-a5d3-943e8e887419","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"messageTemplate\": \"string\",\r\n \"type\": \"sms\",\r\n \"customSendId\": \"string\",\r\n \"contactListIds\": [\r\n \"string\"\r\n ],\r\n \"to\": \"+972521111111\",\r\n \"metadata\": {},\r\n \"from\": \"Test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/campaign/send-test","description":"

Renders campaign template for provided data and sends resulting text to single test phone number

Request parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
messageTemplate	string	Message template with user metadata like [#metadataName#]	required
from	string	Source of the messages campaign	required
to	string	A phone number with plus sign (international format).	required
type	string	Message type which will be sent. Possible values: sms, flash-sms, sms-answer, mms, voice_message, email, premium-message	required
customSendId	string	Client custom send ID of up to 64 characters. The custom send ID will be present in DLR webhook. You can put only one custom send ID per request.	optional
contactListIds	array[string]	Array of contact list ids to be used in campaign	required
metadata	object	Object containing key value pairs of metadata and it's values. Can be empty if no metadata specified.	required

Response parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
id	string	Message campaign id
status	string	Message campaign status
messageQnt	number	Toral amount of messages in campaign
messageQueuedQnt	number	Total amount of queued messages in campaign

","urlObject":{"protocol":"https","path":["api","v1","campaign","send-test"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"ccd1e32a-ce3b-4f5b-8bac-015a9ba61719","name":"Send campaign messages","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"messageTemplate\": \"[#metadataName#] message text\",\r\n \"type\": \"sms\",\r\n \"customSendId\": \"CustomId2\",\r\n \"contactListIds\": [\r\n \"641c2231a0870e33a18dfb10\", \"641c223ee153b414ce8df033\"\r\n ],\r\n \"to\": \"+972521111111\",\r\n \"metadata\": {\r\n \"metadataName\": \"ReceiverName\"\r\n },\r\n \"from\": \"Sender name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/campaign/send"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"633d7ef6c9745250ed7367b3\",\n \"status\": \"created\",\n \"messageQnt\": 123,\n \"messageQueuedQnt\": 34\n}"}],"_postman_id":"6e7249ad-1269-4d74-a5d3-943e8e887419"}],"id":"2d887220-e810-46b0-8317-541fa66b9070","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7685bb4d-a091-4513-96de-ddd3692badd5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4728cc51-2b2b-4eb1-b0e2-a3aa642c015a"}}],"_postman_id":"2d887220-e810-46b0-8317-541fa66b9070","description":""},{"name":"Common","item":[{"name":"Get possible message statuses","id":"98c48d47-b47f-4031-ba9a-99b4dd935bdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

This endpoint returns array of possible message statuses.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"441afdac-99a6-4e56-b1b7-738cdf1cdd43","name":"Get possible message statuses","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"2c2cfc3a-8136-4d53-b7d3-2197dbe6f4876","type":"text","disabled":true}],"url":"https://my.simasti.com/api/v1/common/status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[\n \"prepared\",\n \"inqueue\",\n \"success\",\n \"failure\",\n \"delivered\",\n \"blacklisted\",\n \"greylisted\",\n \"insufficientbalance\",\n \"badturgetnumber\",\n \"routingrulenotfound\",\n \"pricingrulenotfound\",\n \"badsourcenumber\",\n \"sendingdissallowed\",\n \"duplicated\"\n]"}],"_postman_id":"98c48d47-b47f-4031-ba9a-99b4dd935bdf"}],"id":"5fb19622-ee2b-4380-8a69-1641dbf85dfa","_postman_id":"5fb19622-ee2b-4380-8a69-1641dbf85dfa","description":""},{"name":"Inbound messages","item":[{"name":"Get inbound messages","id":"2d709df4-208e-4427-b2bc-dc676220a2ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/inbound-messages?limit=1000","description":"

This enpoint returns client inbound messages.

\n","urlObject":{"protocol":"https","path":["api","v1","inbound-messages"],"host":["my","simasti","com"],"query":[{"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"070b32f9-256e-4e65-896a-078873062668","name":"Get inbound messages","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.simasti.com/api/v1/inbound-messages?limit=1000","protocol":"https","host":["my","simasti","com"],"path":["api","v1","inbound-messages"],"query":[{"key":"limit","value":"1000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 70,\n \"items\": [\n {\n \"body\": \"ב״ה\",\n \"createdAt\": \"2023-05-02T06:27:08.115Z\",\n \"source\": \"0532709876\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:10.128Z\",\n \"source\": \"0522215888\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:14.874Z\",\n \"source\": \"0508727750\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:16.373Z\",\n \"source\": \"0505706850\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:20.449Z\",\n \"source\": \"0506206005\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:20.574Z\",\n \"source\": \"0542918182\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:27.723Z\",\n \"source\": \"0522703001\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:34.694Z\",\n \"source\": \"0547584035\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:37.931Z\",\n \"source\": \"0504969776\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:27:54.181Z\",\n \"source\": \"0544475224\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"??\",\n \"createdAt\": \"2023-05-02T06:28:17.369Z\",\n \"source\": \"0529665699\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:29:01.904Z\",\n \"source\": \"0524333324\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:31:45.077Z\",\n \"source\": \"0538563253\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:32:25.246Z\",\n \"source\": \"0545610805\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן תודה \",\n \"createdAt\": \"2023-05-02T06:33:38.127Z\",\n \"source\": \"0505924100\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:33:43.236Z\",\n \"source\": \"0544553710\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:39:01.224Z\",\n \"source\": \"0522700805\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:39:09.676Z\",\n \"source\": \"0525377442\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:40:39.014Z\",\n \"source\": \"0505671545\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:42:32.761Z\",\n \"source\": \"0505247500\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:43:41.298Z\",\n \"source\": \"0544228200\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן \",\n \"createdAt\": \"2023-05-02T06:44:13.060Z\",\n \"source\": \"0526593434\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:44:35.204Z\",\n \"source\": \"0528366096\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:48:10.865Z\",\n \"source\": \"0523620186\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:50:11.372Z\",\n \"source\": \"0544446973\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:54:34.699Z\",\n \"source\": \"0522286901\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:54:43.074Z\",\n \"source\": \"0527964975\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"בע\\\"ה כן.\",\n \"createdAt\": \"2023-05-02T06:54:53.777Z\",\n \"source\": \"0509251366\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:55:18.436Z\",\n \"source\": \"0507217212\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T06:56:14.334Z\",\n \"source\": \"0505551675\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T07:00:50.711Z\",\n \"source\": \"0522245604\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T07:10:46.741Z\",\n \"source\": \"0545300094\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T07:19:02.477Z\",\n \"source\": \"0505649930\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T07:24:31.210Z\",\n \"source\": \"0544674260\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T07:52:58.366Z\",\n \"source\": \"0506272605\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T08:15:03.788Z\",\n \"source\": \"0524458071\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"טסט 020523\",\n \"createdAt\": \"2023-05-02T08:24:04.637Z\",\n \"source\": \"0544566154\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"טסטס 2\",\n \"createdAt\": \"2023-05-02T09:21:30.611Z\",\n \"source\": \"0544566154\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"טסט 3\",\n \"createdAt\": \"2023-05-02T09:40:15.889Z\",\n \"source\": \"0544566154\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן מאשר \",\n \"createdAt\": \"2023-05-02T09:43:22.854Z\",\n \"source\": \"0506400201\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T13:20:57.331Z\",\n \"source\": \"0543998123\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"טטטטט\",\n \"createdAt\": \"2023-05-02T15:12:36.049Z\",\n \"source\": \"0544566154\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"בדיקה\",\n \"createdAt\": \"2023-05-02T16:40:50.588Z\",\n \"source\": \"0542614780\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T16:58:06.078Z\",\n \"source\": \"0542614780\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-02T17:11:27.314Z\",\n \"source\": \"0542614780\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:28:00.393Z\",\n \"source\": \"0505706850\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:28:06.184Z\",\n \"source\": \"0522833417\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:28:07.439Z\",\n \"source\": \"0544446973\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:28:21.492Z\",\n \"source\": \"0526239220\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"טסט 030523\",\n \"createdAt\": \"2023-05-03T06:29:18.656Z\",\n \"source\": \"0544566154\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:29:42.966Z\",\n \"source\": \"0506272605\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:30:02.918Z\",\n \"source\": \"0523994884\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:30:55.987Z\",\n \"source\": \"0509217504\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:31:22.306Z\",\n \"source\": \"0533390835\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:31:30.777Z\",\n \"source\": \"0529433123\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"בע\\\"ה כן.\",\n \"createdAt\": \"2023-05-03T06:31:58.607Z\",\n \"source\": \"0509251366\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:35:11.880Z\",\n \"source\": \"0522703001\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:35:17.309Z\",\n \"source\": \"0524333324\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:35:39.867Z\",\n \"source\": \"0544238555\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:36:07.901Z\",\n \"source\": \"0506300441\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:36:42.528Z\",\n \"source\": \"0523975456\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:36:55.688Z\",\n \"source\": \"0506274861\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן תודה\",\n \"createdAt\": \"2023-05-03T06:41:59.963Z\",\n \"source\": \"0505924100\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:43:12.834Z\",\n \"source\": \"0524388668\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:51:38.604Z\",\n \"source\": \"0545610805\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:54:05.269Z\",\n \"source\": \"0544553710\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T06:57:49.775Z\",\n \"source\": \"0522660130\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T07:19:59.807Z\",\n \"source\": \"0544475224\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"030523\",\n \"createdAt\": \"2023-05-03T07:21:05.431Z\",\n \"source\": \"0544566154\",\n \"to\": \"052900000\"\n },\n {\n \"body\": \"כן\",\n \"createdAt\": \"2023-05-03T08:14:02.929Z\",\n \"source\": \"0523838775\",\n \"to\": \"052900000\"\n }\n ]\n}"}],"_postman_id":"2d709df4-208e-4427-b2bc-dc676220a2ea"},{"name":"Get client's virtual numbers","id":"eaf9daf3-b137-498b-9313-3efc9f8caa33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.simasti.com/inbound-messages/virtual-numbers","description":"

This enpoint returns client inbound messages.

\n","urlObject":{"protocol":"https","path":["inbound-messages","virtual-numbers"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"60d3e3a6-0a34-4d5e-96ac-b8964ff9f714","name":"Get client's virtual numbers","originalRequest":{"method":"GET","header":[],"url":"https://my.simasti.com/inbound-messages/virtual-numbers"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"items\": [\n {\n \"country\": \"IL\",\n \"webHook\": \"https://webhook.site/7ab2f607-b678-4b34-98c1-ff4eddde6ac5\",\n \"phoneNumber\": \"0529996222\"\n }\n ]\n}"}],"_postman_id":"eaf9daf3-b137-498b-9313-3efc9f8caa33"}],"id":"ab81896b-ec50-49bd-931e-b95a0a0f4c43","_postman_id":"ab81896b-ec50-49bd-931e-b95a0a0f4c43","description":""},{"name":"Webhooks","item":[{"name":"Get client's webhook info","id":"7996a426-5eeb-4cc8-9dfd-513b9e709b82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"*****","type":"text"}],"url":"https://my.simasti.com/api/v1/webhook","urlObject":{"protocol":"https","path":["api","v1","webhook"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7996a426-5eeb-4cc8-9dfd-513b9e709b82"},{"name":"Update webhook for client","id":"f9085fcc-c961-41c3-b960-b65cc356f8a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"*****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://mogo.io/api/v1/webhook/example\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/webhook/main","urlObject":{"protocol":"https","path":["api","v1","webhook","main"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9085fcc-c961-41c3-b960-b65cc356f8a1"},{"name":"Set webhook for client's virtual number","id":"0d54c1b8-5aa5-4549-ad7e-c03c915d3699","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"*****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63e122cdfd7788d5897c8535\",\n \"webhookUrl\": \"https://mogo.io/api/v1/webhook/example\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/webhook/virtual-number","urlObject":{"protocol":"https","path":["api","v1","webhook","virtual-number"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d54c1b8-5aa5-4549-ad7e-c03c915d3699"},{"name":"Update webhook for client's virtual number","id":"fc07881d-38b4-4e5f-9ac8-29f883a91d00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63e122cdfd7788d5897c8535\",\n \"webhookUrl\": \"https://mogo.io/api/v1/webhook/example\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/webhook/virtual-number","urlObject":{"protocol":"https","path":["api","v1","webhook","virtual-number"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc07881d-38b4-4e5f-9ac8-29f883a91d00"},{"name":"Delete webhook from client's virtual number","id":"90f63c12-e114-4d34-80d8-b99fc950b38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"*****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63e122cdfd7788d5897c8535\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/webhook/virtual-number","urlObject":{"protocol":"https","path":["api","v1","webhook","virtual-number"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"90f63c12-e114-4d34-80d8-b99fc950b38e"}],"id":"7eade528-f0f5-4cef-968f-231c6d824d52","_postman_id":"7eade528-f0f5-4cef-968f-231c6d824d52","description":""},{"name":"Short links","item":[{"name":"generate short links","id":"1a08f0e5-dd96-4235-aeb7-f8ecff9a148b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{user_token_client}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phones\": [\n \"+972521111111\"\n ],\n \"urls\": [\n \"https://simasti.com\"\n ],\n \"tag\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/short-links","urlObject":{"protocol":"https","path":["api","v1","short-links"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"1e6f5310-cefe-43bf-9b9e-3f6fccf3ab7e","name":"Generate Trackable Short Links","originalRequest":{"method":"POST","header":[{"key":"x-mogo-account-id","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"phones\": [\n \"+972521111111\"\n ],\n \"urls\": [\n \"https://simasti.com\"\n ],\n \"tag\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/short-links"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"links\": [\n {\n \"fullUrl\": \"https://simasti.com\",\n \"shortUrl\": \"https://55s.ms/X4H_DT\",\n \"phone\": \"+972521111111\",\n \"expiresAt\": \"2025-06-12T07:42:07.652Z\"\n }\n ]\n}"}],"_postman_id":"1a08f0e5-dd96-4235-aeb7-f8ecff9a148b"},{"name":"recieve a collection of short tracked links","id":"3867533a-a031-4ec8-b8e1-1527a2291162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"*****","type":"text"}],"url":"https://my.simasti.com/api/v1/short-links","urlObject":{"protocol":"https","path":["api","v1","short-links"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"6e30fc17-4a3a-44ea-a9ea-98c0c34b51ca","name":"Returns the list of generated short links","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/short-links/CampaignId-1234"},"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"links\": [\n {\n \"fullUrl\": \"https://simasti.com\",\n \"shortUrl\": \"https://55s.ms/X4H_DT\",\n \"phone\": \"+972521111111\",\n \"expiresAt\": \"2025-06-12T08:34:09.460Z\"\n }\n ]\n}"}],"_postman_id":"3867533a-a031-4ec8-b8e1-1527a2291162"}],"id":"1c7fd7d8-6595-4034-82ec-28176211526f","_postman_id":"1c7fd7d8-6595-4034-82ec-28176211526f","description":""},{"name":"OTP verification","item":[{"name":"send OTP code to a recipient","id":"b1cb3f05-d964-41a3-a23a-1eeb041de93a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"*****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"+972521111111\",\n \"senderId\":\"pre-approved-SenderID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/otp-verification/send-otp","urlObject":{"protocol":"https","path":["api","v1","otp-verification","send-otp"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"61fd34b2-cced-4aa3-a3c1-70b83fb3af85","name":"Send otp code to a recipient","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"+972521111111\",\n \"senderId\":\"pre-approved-senderID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/otp-verification/send-otp"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"b1cb3f05-d964-41a3-a23a-1eeb041de93a"},{"name":"verify OTP code for a recipient","id":"63832c71-47c0-4209-a217-f03aa98fe56a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"+972521111111\",\n \"code\": \"456778\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/otp-verification/verify-otp","urlObject":{"protocol":"https","path":["api","v1","otp-verification","verify-otp"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"e763219f-89d9-4042-b767-6c9aa1dec5ab","name":"verify OTP code for a recipient","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phone\": \"+972521111111\",\n \"code\": \"456778\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/otp-verification/verify-otp"},"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"200 OK\n{\n \"otpCodeValid\": true\n}\n\n400 Verification expired or wasn't started with provided phone number.\n\n422 Verification service is temporary unavailable"}],"_postman_id":"63832c71-47c0-4209-a217-f03aa98fe56a"}],"id":"604c3d05-0b18-4096-af5d-3391735bef42","description":"

Note: this function is designed to send OTP outside of Israel, if you are intended to send to Istarl , please use the endpoint

https://my.simasti.com/api/v1/message-send

\n","_postman_id":"604c3d05-0b18-4096-af5d-3391735bef42"},{"name":"IVR and Voice Call Campaigns","item":[{"name":"Get IVR by ID","id":"dc294a75-24b6-4f24-971f-856a77b69cfc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"connection":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/ivr/{id}","description":"

Get IVR campaign by its ID

\n","urlObject":{"protocol":"https","path":["api","v1","ivr","{id}"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"faaa09a2-b9d5-49d0-8298-442e971c4e0f","name":"IVR","originalRequest":{"method":"GET","header":[],"url":"https://my.simasti.com/api/v1/ivr/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"virtualNumber\": \"string\",\n \"status\": \"active\",\n \"language\": \"en-GB\",\n \"states\": [\n {\n \"id\": 0,\n \"actions\": [\n {\n \"action\": \"playAudioFile\",\n \"params\": {\n \"id\": \"fileId\"\n }\n },\n {\n \"action\": \"tts\",\n \"params\": {\n \"text\": \"text to be played\"\n }\n },\n {\n \"action\": \"unsubscribe\"\n },\n {\n \"action\": \"goToState\",\n \"params\": {\n \"id\": 2\n }\n },\n {\n \"action\": \"addToStreamCampaign\",\n \"params\": {\n \"id\": \"streamCampaignId\"\n }\n },\n {\n \"action\": \"hangup\"\n }\n ],\n \"dtmfSwitches\": [\n {\n \"code\": \"0\",\n \"goToState\": 0\n }\n ]\n }\n ],\n \"createdAt\": \"2026-03-19T07:21:48.208Z\",\n \"updatedAt\": \"2026-03-19T07:21:48.208Z\"\n}"}],"_postman_id":"dc294a75-24b6-4f24-971f-856a77b69cfc"},{"name":"list IVRs","id":"ab4aaae3-4d53-43d8-943f-8a8ca374470e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"host":true,"connection":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/ivr?offset=Numeric&limit=Numeric&sortBy=name Or CreatedAt Or status&sortOrder=ASC Or DESC&name=String&status=active. Or Disabled","description":"

List all IVR campaigns

\n","urlObject":{"protocol":"https","path":["v1","ivr"],"host":["my","simasti","comapi"],"query":[{"description":{"content":"

Offset from start of the returned set

\n","type":"text/plain"},"key":"offset","value":"Numeric"},{"description":{"content":"

max records to return

\n","type":"text/plain"},"key":"limit","value":"Numeric"},{"description":{"content":"

value to order by

\n","type":"text/plain"},"key":"sortBy","value":"name Or CreatedAt Or status"},{"description":{"content":"

direction of the order

\n","type":"text/plain"},"key":"sortOrder","value":"ASC Or DESC"},{"description":{"content":"

match this name

\n","type":"text/plain"},"key":"name","value":"String"},{"description":{"content":"

weather the campagn is in active or disabled status

\n","type":"text/plain"},"key":"status","value":"active. Or Disabled"}],"variable":[]}},"response":[{"id":"6f1cf7cf-48c9-40fb-8536-f336bf10471a","name":"IVR","originalRequest":{"method":"GET","header":[{"key":"x-mogo-account-id","value":"","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://my.simasti.comapi/v1/ivr?offset=Numeric&limit=Numeric&sortBy=name Or CreatedAt Or status&sortOrder=ASC Or DESC&name=String&status=active. Or Disabled","protocol":"https","host":["my","simasti","comapi"],"path":["v1","ivr"],"query":[{"key":"offset","value":"Numeric","description":"Offset from start of the returned set"},{"key":"limit","value":"Numeric","description":"max records to return"},{"key":"sortBy","value":"name Or CreatedAt Or status","description":"value to order by"},{"key":"sortOrder","value":"ASC Or DESC","description":"direction of the order"},{"key":"name","value":"String","description":"match this name"},{"key":"status","value":"active. Or Disabled","description":"weather the campagn is in active or disabled status"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"total\": 0,\n \"ivrs\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"virtualNumber\": \"string\",\n \"status\": \"active\",\n \"language\": \"en-GB\",\n \"states\": [\n {\n \"id\": 0,\n \"actions\": [\n {\n \"action\": \"playAudioFile\",\n \"params\": {\n \"id\": \"fileId\"\n }\n },\n {\n \"action\": \"tts\",\n \"params\": {\n \"text\": \"text to be played\"\n }\n },\n {\n \"action\": \"unsubscribe\"\n },\n {\n \"action\": \"goToState\",\n \"params\": {\n \"id\": 2\n }\n },\n {\n \"action\": \"addToStreamCampaign\",\n \"params\": {\n \"id\": \"streamCampaignId\"\n }\n },\n {\n \"action\": \"hangup\"\n }\n ],\n \"dtmfSwitches\": [\n {\n \"code\": \"0\",\n \"goToState\": 0\n }\n ]\n }\n ],\n \"createdAt\": \"2026-03-18T11:49:24.347Z\",\n \"updatedAt\": \"2026-03-18T11:49:24.347Z\"\n }\n ]\n}"}],"_postman_id":"ab4aaae3-4d53-43d8-943f-8a8ca374470e"},{"name":"Create IVR","id":"e9549cff-95bb-44de-8913-1a01a8246726","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"language\": \"string\",\n \"virtualNumber\": \"string\",\n \"states\": [\n {\n \"id\": 0,\n \"actions\": [\n {\n \"action\": \"playAudioFile\",\n \"params\": {\n \"id\": \"fileId\"\n }\n },\n {\n \"action\": \"tts\",\n \"params\": {\n \"text\": \"text to be played\"\n }\n },\n {\n \"action\": \"unsubscribe\"\n },\n {\n \"action\": \"goToState\",\n \"params\": {\n \"id\": 2\n }\n },\n {\n \"action\": \"addToStreamCampaign\",\n \"params\": {\n \"id\": \"streamCampaignId\"\n }\n },\n {\n \"action\": \"hangup\"\n }\n ],\n \"dtmfSwitches\": [\n {\n \"code\": \"0\",\n \"goToState\": 0\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/ivr?name=string&language=String&virtualNumber=String&states=Object[] &dtmfSwitches=Object[]","description":"

create a new IVR

\n","urlObject":{"protocol":"https","path":["v1","ivr"],"host":["my","simasti","comapi"],"query":[{"description":{"content":"

name of the IVR campaign

\n","type":"text/plain"},"key":"name","value":"string"},{"key":"language","value":"String"},{"key":"virtualNumber","value":"String"},{"description":{"content":"

Array of possible Actions for this IVR campaign fot example - Play text ( text2voice ), add to stream campaign etc.

\n","type":"text/plain"},"key":"states","value":"Object[] "},{"key":"dtmfSwitches","value":"Object[]"}],"variable":[]}},"response":[{"id":"4b136f4f-96c8-4201-ae65-cd36f4339e0b","name":"IVR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"language\": \"string\",\n \"virtualNumber\": \"string\",\n \"states\": [\n {\n \"id\": 0,\n \"actions\": [\n {\n \"action\": \"playAudioFile\",\n \"params\": {\n \"id\": \"fileId\"\n }\n },\n {\n \"action\": \"tts\",\n \"params\": {\n \"text\": \"text to be played\"\n }\n },\n {\n \"action\": \"unsubscribe\"\n },\n {\n \"action\": \"goToState\",\n \"params\": {\n \"id\": 2\n }\n },\n {\n \"action\": \"addToStreamCampaign\",\n \"params\": {\n \"id\": \"streamCampaignId\"\n }\n },\n {\n \"action\": \"hangup\"\n }\n ],\n \"dtmfSwitches\": [\n {\n \"code\": \"0\",\n \"goToState\": 0\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/ivr"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"e9549cff-95bb-44de-8913-1a01a8246726"},{"name":"Update IVR","id":"abe3cf7c-f4b1-400e-9891-a088843f4d6d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true,"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"language\": \"string\",\n \"virtualNumber\": \"string\",\n \"states\": [\n {\n \"id\": 0,\n \"actions\": [\n {\n \"action\": \"playAudioFile\",\n \"params\": {\n \"id\": \"fileId\"\n }\n },\n {\n \"action\": \"tts\",\n \"params\": {\n \"text\": \"text to be played\"\n }\n },\n {\n \"action\": \"unsubscribe\"\n },\n {\n \"action\": \"goToState\",\n \"params\": {\n \"id\": 2\n }\n },\n {\n \"action\": \"addToStreamCampaign\",\n \"params\": {\n \"id\": \"streamCampaignId\"\n }\n },\n {\n \"action\": \"hangup\"\n }\n ],\n \"dtmfSwitches\": [\n {\n \"code\": \"0\",\n \"goToState\": 0\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.simasti.comapi/v1/ivr/{id}","urlObject":{"protocol":"https","path":["v1","ivr","{id}"],"host":["my","simasti","comapi"],"query":[],"variable":[]}},"response":[],"_postman_id":"abe3cf7c-f4b1-400e-9891-a088843f4d6d"},{"name":"Delete IVR","id":"5c391d5b-1a55-4f7b-9af3-34c0230631ab","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"accept":true,"user-agent":true,"accept-encoding":true,"connection":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"accept","value":"application/json","type":"text"}],"url":"https://my.simasti.com/api/v1/ivr/{id}","urlObject":{"protocol":"https","path":["api","v1","ivr","{id}"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"f20a1ad6-e564-4b21-819a-ae942277e2bf","name":"Delete IVR","originalRequest":{"method":"DELETE","header":[],"url":"https://my.simasti.com/api/v1/ivr/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"5c391d5b-1a55-4f7b-9af3-34c0230631ab"},{"name":"Deactivate IVR","id":"035f80d8-4fef-4688-ad0a-51e37b92f5e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[],"url":"https://my.simasti.com/api/v1/ivr/{id}","urlObject":{"protocol":"https","path":["api","v1","ivr","{id}"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"1206eff7-6b9f-48fc-8096-f4f7edbde8b5","name":"Deactivate IVR","originalRequest":{"method":"PUT","header":[],"url":"https://my.simasti.com/api/v1/ivr/{id}/disable"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"035f80d8-4fef-4688-ad0a-51e37b92f5e9"},{"name":"Activate IVR","id":"7d68dc2e-0f95-4277-8219-5d5f080f0f0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"089ffcfa-84f1-4d91-9af5-81397333b538","name":"Activate IVR","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"7d68dc2e-0f95-4277-8219-5d5f080f0f0c"},{"name":"List Audio Recordings","id":"25af3a9a-451c-4504-ae0e-65d815bcd6f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63e122cdfd7788d5897c8535\",\n \"webhookUrl\": \"https://mogo.io/api/v1/webhook/example\"\n}"},"url":"https://my.simasti.com/api/v1/audioRecordings?offset=Integer&Limit=Integer","urlObject":{"protocol":"https","path":["api","v1","audioRecordings"],"host":["my","simasti","com"],"query":[{"key":"offset","value":"Integer"},{"key":"Limit","value":"Integer"}],"variable":[]}},"response":[{"id":"8b05a01a-3988-4246-8e2a-26e1f8c93b78","name":"List Audio Recordings","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"****","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63e122cdfd7788d5897c8535\",\n \"webhookUrl\": \"https://mogo.io/api/v1/webhook/example\"\n}"},"url":{"raw":"https://my.simasti.com/api/v1/audioRecordings?offset=Integer&Limit=Integer","protocol":"https","host":["my","simasti","com"],"path":["api","v1","audioRecordings"],"query":[{"key":"offset","value":"Integer"},{"key":"Limit","value":"Integer"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"total\": 0,\n \"ivrs\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"virtualNumber\": \"string\",\n \"status\": \"active\",\n \"language\": \"en-GB\",\n \"states\": [\n {\n \"id\": 0,\n \"actions\": [\n {\n \"action\": \"playAudioFile\",\n \"params\": {\n \"id\": \"fileId\"\n }\n },\n {\n \"action\": \"tts\",\n \"params\": {\n \"text\": \"text to be played\"\n }\n },\n {\n \"action\": \"unsubscribe\"\n },\n {\n \"action\": \"goToState\",\n \"params\": {\n \"id\": 2\n }\n },\n {\n \"action\": \"addToStreamCampaign\",\n \"params\": {\n \"id\": \"streamCampaignId\"\n }\n },\n {\n \"action\": \"hangup\"\n }\n ],\n \"dtmfSwitches\": [\n {\n \"code\": \"0\",\n \"goToState\": 0\n }\n ]\n }\n ],\n \"createdAt\": \"2026-03-19T07:39:03.555Z\",\n \"updatedAt\": \"2026-03-19T07:39:03.555Z\"\n }\n ]\n}"}],"_postman_id":"25af3a9a-451c-4504-ae0e-65d815bcd6f9"},{"name":"callHistory","id":"f83bdf83-1238-448d-b421-36a3462fc7c0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true,"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"offset","value":"int","type":"text","uuid":"9e42806d-52d2-46f0-a001-055c35e10949"},{"key":"limit","value":"int","type":"text","uuid":"e6c9bd24-0ca6-4ac5-a818-af05c11da355"},{"key":"sortBy","value":"predefined value","description":"

\n","type":"text","uuid":"e058162a-53e4-4bdc-afbb-f574ab406366"},{"key":"sortOrder","value":"predefined value","description":"

DESC | ASC

\n","type":"text","uuid":"1f2f7858-48cc-4ba2-a87a-4b926e5f531e"},{"key":"callerId","value":"","type":"text","uuid":"79004eb9-6ad5-439a-8c0f-970172cf8a51"},{"key":"virtualNumber","value":"phone number","type":"text","uuid":"7cd453ba-9c66-4850-8162-9019e4c1a98a"},{"key":"status","value":"predefined value","description":"

online | hungUp

\n","type":"text","uuid":"92aa4b72-beb6-420c-bef2-a2f4e7cc6347"}]},"url":"https://my.simasti.com/api/v1/ivr/callHistory","urlObject":{"protocol":"https","path":["api","v1","ivr","callHistory"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"74b49f68-2081-47cf-b7b0-822d9451f5cf","name":"callHistory","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"offset","value":"Int","type":"text","uuid":"7e22d2af-aa24-4bd0-b9d3-55ed34cd4b00"},{"key":"limit","value":"Iint","type":"text","uuid":"bcaa9e3f-d0d6-436b-8cb1-dac3f336d1c6"},{"key":"sortBy","value":"predefined value","description":"options createdAt | endedAt | callerId | status | duration | virtualNumber","type":"text","uuid":"7fee5900-cb81-40a9-91f7-c91401a80dc0"},{"key":"sortOrder","value":"predefined value","description":"DESC | ASC","type":"text","uuid":"8fd689f6-efcc-4449-9f05-c62eb1e80a1a"},{"key":"callerId","value":"int","type":"text","uuid":"87b0f243-077f-4b97-845a-d4f7f415c948"},{"key":"virtualNumber","value":"Phone Number ","description":"thep virtual Number that was assigned to your account","type":"text","uuid":"a11e0d41-97f3-4891-97fb-5835b0b9985a"},{"key":"status","value":"predefined value","description":"online | hungup","type":"text","uuid":"f9ef9efd-b901-4e98-ac0c-c0b82c004d73"}],"options":{"raw":{"language":"json"}}},"url":"https://my.simasti.com/api/v1/ivr/callHistory"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"total\": 0,\n \"calls\": [\n {\n \"id\": \"string\",\n \"callerId\": \"string\",\n \"virtualNumber\": \"string\",\n \"status\": \"online\",\n \"actions\": [\n {\n \"action\": \"unsubscribe\"\n }\n ],\n \"createdAt\": \"2026-05-06T08:15:08.138Z\",\n \"updatedAt\": \"2026-05-06T08:15:08.138Z\",\n \"endedAt\": \"2026-05-06T08:15:08.138Z\",\n \"dtmfHistory\": \"string\",\n \"duration\": 0\n }\n ]\n}"}],"_postman_id":"f83bdf83-1238-448d-b421-36a3462fc7c0"},{"name":"Upload Audio Recording","id":"1a96e8f3-d3ed-431b-aa0b-d2689f3486ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","value":"audioFile.wav","description":"

Audio files , max 10MB, extentions allowed : wav or MP3

\n","type":"text","uuid":"35adebbf-9879-4ca8-b0e8-0af83c0d4fe4"}]},"url":"https://my.simasti.com/api/v1/ivr/uploadAudioRecording","urlObject":{"protocol":"https","path":["api","v1","ivr","uploadAudioRecording"],"host":["my","simasti","com"],"query":[],"variable":[]}},"response":[{"id":"784597f5-8b0b-47d2-aae0-b805e437391d","name":"Upload Audio Recording","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","value":"myAudioFile.mp3","description":"your audio file","type":"text","uuid":"ab22985f-ffb5-4bf5-a93a-80d4f7b90cb1"}],"options":{"raw":{"language":"json"}}},"url":"/api/v1/ivr/uploadAudioRecording"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"12121212\"\n}"}],"_postman_id":"1a96e8f3-d3ed-431b-aa0b-d2689f3486ab"}],"id":"a9d97a1e-fb86-4815-88df-fd5f3f70aff0","description":"

This functionality is currently being added to the document. its still incomplete

\n","_postman_id":"a9d97a1e-fb86-4815-88df-fd5f3f70aff0"}],"event":[{"listen":"prerequest","script":{"id":"101ea151-d7df-41cc-92f9-051579a3c4a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8a77f0e4-d0d7-48fd-b535-64cb96271c1a","type":"text/javascript","exec":["pm.test(\"Response time is less than 500ms\", () => {"," pm.expect(pm.response.responseTime).to.be.below(500);","});",""]}}],"variable":[{"id":"ced30601-de6b-4d1a-a83c-2e0a5477d377","key":"x-mogo-account-id","value":""}]}