Note API: Difference between revisions
m remove : in category tag |
m automatic correction by IA |
||
| Line 7: | Line 7: | ||
}} | }} | ||
Note API allows you to send email and text messages (SMS) using a secure 256-bit HTTPS encryption protocol. When you make a request to the Note API to send an interaction, we will validate the request and if successful we will process the interaction, if not we will display the appropriate error message. | Note API allows you to send email and text messages (SMS) using a secure 256-bit HTTPS encryption protocol. When you make a request to the Note API to send an interaction, we will validate the request and if successful we will process the interaction, if not we will display the appropriate error message. | ||
== Send Email Message == | == Send Email Message == | ||
Note API <code>sent</code> request should be used with <code>_type</code> = <code>email</code> parameter when sending email | Note API <code>sent</code> request should be used with <code>_type</code> = <code>email</code> parameter when sending email interactions over the Note API. All parameters below are required. | ||
<br /> | <br /> | ||
== Send Text (SMS) Message == | == Send Text (SMS) Message == | ||
Note API <code>sent</code> request should be used with <code>_type</code> = <code>text</code> parameter when sending text (SMS) | Note API <code>sent</code> request should be used with <code>_type</code> = <code>text</code> parameter when sending text (SMS) interactions over the Note API. All parameters below are required. | ||
<br /> | <br /> | ||
== API Success & Errors Responses == | == API Success & Errors Responses == | ||
If your API request fails, the API will return an error object, which contains the sub-objects code and message indicating which type of error has occurred. If a validation error occurs, there will be an additional context sub-object containing information about one or multiple validation errors. The API also supports universal HTTP status codes. For successful API requests, you can expect the HTTP code 200. | If your API request fails, the API will return an error object, which contains the sub-objects code and message indicating which type of error has occurred. If a validation error occurs, there will be an additional context sub-object containing information about one or multiple validation errors. The API also supports universal HTTP status codes. For successful API requests, you can expect the HTTP code 200. | ||
{{AFC submission|t||ts=20200410141157|u=Ioffeben|ns=118|demo=}}<!-- Important, do not remove this line before article has been created. --> | {{AFC submission|t||ts=20200410141157|u=Ioffeben|ns=118|demo=}}<!-- Important, do not remove this line before article has been created. --> | ||
[https://noteapi.com https://noteapi.com/] | [https://noteapi.com https://noteapi.com/] | ||
== References == | == References == | ||
Latest revision as of 01:11, 13 October 2025
| Note API | |
|---|---|
| Born | |
| 💼 Occupation | |
| 🌐 Website | https://noteapi.com |
Note API allows you to send email and text messages (SMS) using a secure 256-bit HTTPS encryption protocol. When you make a request to the Note API to send an interaction, we will validate the request and if successful we will process the interaction, if not we will display the appropriate error message.
Send Email Message
Note API sent request should be used with _type = email parameter when sending email interactions over the Note API. All parameters below are required.
Send Text (SMS) Message
Note API sent request should be used with _type = text parameter when sending text (SMS) interactions over the Note API. All parameters below are required.
API Success & Errors Responses
If your API request fails, the API will return an error object, which contains the sub-objects code and message indicating which type of error has occurred. If a validation error occurs, there will be an additional context sub-object containing information about one or multiple validation errors. The API also supports universal HTTP status codes. For successful API requests, you can expect the HTTP code 200.
References
This article "Note API" is from Wikipedia. The list of its authors can be seen in its historical and/or the page Edithistory:Note API. Articles copied from Draft Namespace on Wikipedia could be seen on the Draft Namespace of Wikipedia and not main one.
