id stringlengths 53 86 | api_name stringlengths 2 76 | api_description stringlengths 1 500 ⌀ | api_score float64 0 10 ⌀ | endpoint_name stringlengths 1 190 | endpoint_description stringlengths 0 500 | response_status_code int64 100 505 | response_summary stringlengths 1 68 ⌀ | response_json stringlengths 6 50k | response_json_schema stringlengths 14 150k |
|---|---|---|---|---|---|---|---|---|---|
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/5605948d-7ab6-4ed1-b32c-9b94af65ba6e/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Send Viber Message | D7's Viber Messaging API is designed to meet a wide range of use cases and can be seamlessly integrated into any system. With this API, you can effortlessly implement single Viber messages or personalized batch Viber messages, catering to your specific needs. | 402 | Validation Error | {"detail": [{"loc": ["string"], "msg": "string", "type": "string"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": "string"}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "required": ["detail... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/5605948d-7ab6-4ed1-b32c-9b94af65ba6e/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Send Viber Message | D7's Viber Messaging API is designed to meet a wide range of use cases and can be seamlessly integrated into any system. With this API, you can effortlessly implement single Viber messages or personalized batch Viber messages, catering to your specific needs. | 401 | Unauthorized | {"detail": {"code": "ACCESS_TOKEN_SIGNATURE_VERIFICATION_FAILED", "message": "Access token signature verification failed"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/5605948d-7ab6-4ed1-b32c-9b94af65ba6e/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Send Viber Message | D7's Viber Messaging API is designed to meet a wide range of use cases and can be seamlessly integrated into any system. With this API, you can effortlessly implement single Viber messages or personalized batch Viber messages, catering to your specific needs. | 200 | Success Response | {"request_id": "d9835609-a4e0-10ea-a26a-eeafbe700fef", "status": "accepted", "created_at": "2001-08-05T12:52:38.393Z"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"request_id": {"type": "string"}, "status": {"type": "string"}, "created_at": {"type": "string"}}, "required": ["created_at", "request_id", "status"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/2fa9aadd-2214-4680-97ee-a0fe089980d3/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | NumLookup | Using this endpoint get detailed information about the phone number, including the carrier name, country code, number type (landline or mobile), and other relevant details | 401 | Unauthorized | {"detail": {"code": "ACCESS_TOKEN_SIGNATURE_VERIFICATION_FAILED", "message": "Access token signature verification failed"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/2fa9aadd-2214-4680-97ee-a0fe089980d3/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | NumLookup | Using this endpoint get detailed information about the phone number, including the carrier name, country code, number type (landline or mobile), and other relevant details | 402 | Validation Error | {"detail": [{"loc": ["body", "recipient"], "msg": "field required", "type": "value_error.missing"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": "string"}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "required": ["detail... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/2fa9aadd-2214-4680-97ee-a0fe089980d3/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | NumLookup | Using this endpoint get detailed information about the phone number, including the carrier name, country code, number type (landline or mobile), and other relevant details | 200 | Success Response | {"country": "AE", "recipient": "+971509752655", "present": "yes", "network": "Emirates Telecom Corp-ETISALAT", "mcc": 424, "mnc": 2, "ported": false, "cic": "971500", "imsi": "42402XXXXXXXXXX", "ocn": null, "type": "mobile", "lookup_code": 0, "lookup_description": null, "request_id": "b3aeaf81-608c-4133-9c7a-b7faea84f9... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"country": {"type": "string"}, "recipient": {"type": "string"}, "present": {"type": "string"}, "network": {"type": "string"}, "mcc": {"type": "integer"}, "mnc": {"type": "integer"}, "ported": {"type": "boolean"}, "cic": {"type": "string"}, "... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/dac03d6e-ef6c-4af4-a202-386031c19409/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Resend OTP | If the OTP is not received by the customer, you can use the Resend OTP endpoint to generate a new one. Before requesting a resend, there must be a minimum 60-second delay, which can be adjusted in profile. | 200 | Success Response | {"otp_id": "8d963dbf-d655-4fe6-9157-48885a036050", "status": "OPEN", "expiry": 600, "resend_count": 1} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"otp_id": {"type": "string"}, "status": {"type": "string"}, "expiry": {"type": "integer"}, "resend_count": {"type": "integer"}}, "required": ["expiry", "otp_id", "resend_count", "status"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/dac03d6e-ef6c-4af4-a202-386031c19409/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Resend OTP | If the OTP is not received by the customer, you can use the Resend OTP endpoint to generate a new one. Before requesting a resend, there must be a minimum 60-second delay, which can be adjusted in profile. | 422 | Validation Error | {"detail": [{"loc": ["string", 0], "msg": "string", "type": "string"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": ["integer", "string"]}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "requir... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/dac03d6e-ef6c-4af4-a202-386031c19409/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Resend OTP | If the OTP is not received by the customer, you can use the Resend OTP endpoint to generate a new one. Before requesting a resend, there must be a minimum 60-second delay, which can be adjusted in profile. | 400 | Frequent resend request | {"detail": "Frequent resend request, resend request need minimum 60 seconds delay"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/dac03d6e-ef6c-4af4-a202-386031c19409/2/1 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Resend OTP | If the OTP is not received by the customer, you can use the Resend OTP endpoint to generate a new one. Before requesting a resend, there must be a minimum 60-second delay, which can be adjusted in profile. | 400 | OTP time limit expired | {"detail": "Resend Failed. OTP time limit expired."} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "string"}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/3a099cd5-8545-4c30-9908-25c3b7ba8ddc/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Get OTP Status | Get the status of OTP generated or verified | 404 | Not Found | {"detail": {"code": "MESSAGE_LOG_NOT_EXISTS", "message": "Given message otp id not exists in the system. Please Try Again!"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/3a099cd5-8545-4c30-9908-25c3b7ba8ddc/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Get OTP Status | Get the status of OTP generated or verified | 422 | Validation Error | {"detail": [{"loc": ["string", 0], "msg": "string", "type": "string"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": ["integer", "string"]}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "requir... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/3a099cd5-8545-4c30-9908-25c3b7ba8ddc/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Get OTP Status | Get the status of OTP generated or verified | 200 | Success Response | {"status": "OPEN"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}}, "required": ["status"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/34a9cc70-f0dc-42a6-8daa-6626cb68c189/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Get Message Status | Get Message Delivery Status of previously sent messages. | 200 | Success Response | {"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "total_recipients": 1, "channel": "string", "messages": [{"msg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "country": "string", "recipient": "string", "status": "rejected", "number_of_sms": 1, "sms_cost": 0.001, "schedule_time": "2022-08-18T12:41:04.603Z"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"request_id": {"type": "string"}, "total_recipients": {"type": "integer"}, "channel": {"type": "string"}, "messages": {"type": "array", "items": {"type": "object", "properties": {"msg_id": {"type": "string"}, "country": {"type": "string"}, "... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/34a9cc70-f0dc-42a6-8daa-6626cb68c189/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Get Message Status | Get Message Delivery Status of previously sent messages. | 422 | Validation Error | {"detail": [{"loc": ["path", "req_id"], "msg": "value is not a valid uuid", "type": "type_error.uuid"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": "string"}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "required": ["detail... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/34a9cc70-f0dc-42a6-8daa-6626cb68c189/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Get Message Status | Get Message Delivery Status of previously sent messages. | 404 | Not Found | {"detail": {"code": "MESSAGE_LOG_NOT_EXISTS", "message": "Given message request id not exists in the system. Please Try Again!"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/06889080-3374-4f36-8412-2a9469df7ad7/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | D7API - Check Balance | Get information about current balance on your D7API account | 200 | Success Response | {"balance": 99.9999999} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"balance": {"type": "number"}}, "required": ["balance"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/06889080-3374-4f36-8412-2a9469df7ad7/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | D7API - Check Balance | Get information about current balance on your D7API account | 401 | Unauthorized | {"detail": {"code": "ACCESS_TOKEN_SIGNATURE_VERIFICATION_FAILED", "message": "Access token signature verification failed"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/7e3413eb-6ea5-47d8-b89f-09ff69e917d9/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Generate OTP | Send an OTP to a mobile number for verification. Once the customer receives it and enters it in your app, then you can call the Verify OTP endpoint to verify it | 422 | Validation Error | {"detail": [{"loc": ["string", 0], "msg": "string", "type": "string"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": ["integer", "string"]}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "requir... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/7e3413eb-6ea5-47d8-b89f-09ff69e917d9/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Generate OTP | Send an OTP to a mobile number for verification. Once the customer receives it and enters it in your app, then you can call the Verify OTP endpoint to verify it | 401 | Unauthorized | {"detail": {"code": "ACCESS_TOKEN_SIGNATURE_VERIFICATION_FAILED", "message": "Access token signature verification failed"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/7e3413eb-6ea5-47d8-b89f-09ff69e917d9/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Generate OTP | Send an OTP to a mobile number for verification. Once the customer receives it and enters it in your app, then you can call the Verify OTP endpoint to verify it | 200 | Success Response | {"otp_id": "dfd31c0e-2cd2-494e-88d2-6cac05263a7f", "status": "OPEN", "expiry": 600} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"otp_id": {"type": "string"}, "status": {"type": "string"}, "expiry": {"type": "integer"}}, "required": ["expiry", "otp_id", "status"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/acc61072-7081-421c-8870-8c6f4b421a22/0/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Verify OTP | At this endpoint, you can verify the OTP the customer enters in your application. | 400 | Invalid OTP | {"detail": {"code": "INVALID_OTP_CODE", "message": "Invalid OTP code or OTP code expired"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/acc61072-7081-421c-8870-8c6f4b421a22/1/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Verify OTP | At this endpoint, you can verify the OTP the customer enters in your application. | 422 | Validation Error | {"detail": [{"loc": ["string", 0], "msg": "string", "type": "string"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": ["integer", "string"]}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "requir... |
4b1a2551-9995-4dbe-95f9-ecdc606a0b08/acc61072-7081-421c-8870-8c6f4b421a22/2/0 | D7SMS | Unlock boundless connectivity with D7API Gateway, seamlessly connecting you to the world's vast messaging network through D7's exclusive network access | 9.5 | Verify OTP | At this endpoint, you can verify the OTP the customer enters in your application. | 200 | Success Response | {"status": "APPROVED"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}}, "required": ["status"]} |
3319a1e6-ba3e-4b87-b168-4f3779117f8d/06697628-d680-444c-9e4e-51d28db71468/0/0 | PhoneNumberValidate | Validate any phone number in any country | 8.6 | ValidateTest | Validate any phone number from any country. For testing purposes only. | 200 | Response | {"phoneNumberEntered": "+59894887766", "defaultCountryEntered": "", "languageEntered": "en", "countryCode": "598", "nationalNumber": "94887766", "extension": "", "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN", "italianLeadingZero": false, "rawInput": "+59894887766", "isPossibleNumber": true, "isValidNumber": true, "... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"phoneNumberEntered": {"type": "string"}, "defaultCountryEntered": {"type": "string"}, "languageEntered": {"type": "string"}, "countryCode": {"type": "string"}, "nationalNumber": {"type": "string"}, "extension": {"type": "string"}, "countryC... |
3319a1e6-ba3e-4b87-b168-4f3779117f8d/3485e07f-6a3d-4700-ab66-cdbd83aedc67/0/0 | PhoneNumberValidate | Validate any phone number in any country | 8.6 | Validate | Validate any phone number from any country. | 200 | Response | {"phoneNumberEntered": "94887799", "defaultCountryEntered": "UY", "languageEntered": "en", "countryCode": "598", "nationalNumber": "94887799", "extension": "", "countryCodeSource": "FROM_DEFAULT_COUNTRY", "italianLeadingZero": false, "rawInput": "94887799", "isPossibleNumber": true, "isValidNumber": true, "isValidNumbe... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"phoneNumberEntered": {"type": "string"}, "defaultCountryEntered": {"type": "string"}, "languageEntered": {"type": "string"}, "countryCode": {"type": "string"}, "nationalNumber": {"type": "string"}, "extension": {"type": "string"}, "countryC... |
a25a876e-5bad-4132-b399-0b644a05abcf/e29d1d07-6b3c-4eec-9a7b-b0a6bad91e23/0/0 | PhoneNumberValidateFree | Free and easy. Validate any phone number, from any country.
Get type of number (for example, fixed line or mobile), the location of the number, and also reformat the number into local and international dialing formats. | 9.9 | Validate | Free and easy. Validate any phone number, from any country.
Get type of number (for example, fixed line or mobile), the location of the number, and also reformat the number into local and international dialing formats. | 200 | Response | {"phoneNumberEntered": "94887799", "defaultCountryEntered": "UY", "languageEntered": "en", "countryCode": "598", "nationalNumber": "94887799", "extension": "", "countryCodeSource": "FROM_DEFAULT_COUNTRY", "italianLeadingZero": false, "rawInput": "94887799", "isPossibleNumber": true, "isValidNumber": true, "isValidNumbe... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"phoneNumberEntered": {"type": "string"}, "defaultCountryEntered": {"type": "string"}, "languageEntered": {"type": "string"}, "countryCode": {"type": "string"}, "nationalNumber": {"type": "string"}, "extension": {"type": "string"}, "countryC... |
515196ec-2a07-4d2e-93b6-4d2a65881a53/495786a7-8bfb-4ea2-98c2-377765ba2553/0/0 | Whatsapp Checker PRO | You only have to send us contact mobile numbers and we will filter the numbers registered on whatsapp
The service helps you to promote your services efficiently | 8.5 | Validate PhoneNumber | Whatsapp Validate PhoneNumber | 200 | New Example | {"code": "value", "response": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "string"}, "response": {"type": "string"}}, "required": ["code", "response"]} |
3b0566a5-f6ef-466b-b1f3-7bc55826edc3/ec3861c6-277b-4df0-8f31-5f9e40816053/0/0 | TextFlow SMS API | An api for sending text messages and verifying users using their phone numbers
www.textflow.me | 9.8 | Send SMS | Send a text message by targeting this POST endpoint. Provide phone_number and text in the body and we will send you a response. Make sure that phone_number has a country code. | 200 | New Example | {"ok": true, "status": 200, "message": "Message sent successfully", "data": {"to": "+17632736140", "content": "Test message from TextFlow", "country_code": "Canada", "timestamp": 1675526082088}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"ok": {"type": "boolean"}, "status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"to": {"type": "string"}, "content": {"type": "string"}, "country_code": {"type": "string"}, "timestamp": {"ty... |
3b0566a5-f6ef-466b-b1f3-7bc55826edc3/641aad60-6e53-4763-af2c-51a98cdc3146/0/0 | TextFlow SMS API | An api for sending text messages and verifying users using their phone numbers
www.textflow.me | 9.8 | Check OTP verification code | One your user inputs the code that they received, send that code and users phone_number to this endpoint to complete verification. | 400 | New Example | {"ok": true, "valid": false, "valid_code": "609613", "expires": 1675531784155, "status": 400, "message": "The code is invalid. "} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"ok": {"type": "boolean"}, "valid": {"type": "boolean"}, "valid_code": {"type": "string"}, "expires": {"type": "integer"}, "status": {"type": "integer"}, "message": {"type": "string"}}, "required": ["expires", "message", "ok", "status", "val... |
8c90d93d-10d9-49ed-af90-b5875cac8f3d/26a98af7-f3f5-4231-a709-6ac9987e5096/0/0 | D7 Number Validator | The D7 Number Lookup API allows you to retrieve various details associated with a given phone number, including the carrier name, country code, number type (landline or mobile), and other relevant information. | null | Validate Number | Using this endpoint get detailed information about the phone number, including the carrier name, country code, number type (landline or mobile), and other relevant details | 401 | Unauthorized | {"detail": {"code": "ACCESS_TOKEN_SIGNATURE_VERIFICATION_FAILED", "message": "Access token signature verification failed"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["code", "message"]}}, "required": ["detail"]} |
8c90d93d-10d9-49ed-af90-b5875cac8f3d/26a98af7-f3f5-4231-a709-6ac9987e5096/1/0 | D7 Number Validator | The D7 Number Lookup API allows you to retrieve various details associated with a given phone number, including the carrier name, country code, number type (landline or mobile), and other relevant information. | null | Validate Number | Using this endpoint get detailed information about the phone number, including the carrier name, country code, number type (landline or mobile), and other relevant details | 402 | Validation Error | {"detail": [{"loc": ["body", "recipient"], "msg": "field required", "type": "value_error.missing"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"detail": {"type": "array", "items": {"type": "object", "properties": {"loc": {"type": "array", "items": {"type": "string"}}, "msg": {"type": "string"}, "type": {"type": "string"}}, "required": ["loc", "msg", "type"]}}}, "required": ["detail... |
8c90d93d-10d9-49ed-af90-b5875cac8f3d/26a98af7-f3f5-4231-a709-6ac9987e5096/2/0 | D7 Number Validator | The D7 Number Lookup API allows you to retrieve various details associated with a given phone number, including the carrier name, country code, number type (landline or mobile), and other relevant information. | null | Validate Number | Using this endpoint get detailed information about the phone number, including the carrier name, country code, number type (landline or mobile), and other relevant details | 200 | Success Response | {"country": "AE", "recipient": "+971509752655", "present": "yes", "network": "Emirates Telecom Corp-ETISALAT", "mcc": 424, "mnc": 2, "ported": false, "cic": "971500", "imsi": "42402XXXXXXXXXX", "ocn": null, "type": "mobile", "lookup_code": 0, "lookup_description": null, "request_id": "b3aeaf81-608c-4133-9c7a-b7faea84f9... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"country": {"type": "string"}, "recipient": {"type": "string"}, "present": {"type": "string"}, "network": {"type": "string"}, "mcc": {"type": "integer"}, "mnc": {"type": "integer"}, "ported": {"type": "boolean"}, "cic": {"type": "string"}, "... |
6fa93768-8f11-4c58-8942-f81948358d38/772205df-b244-4ad6-85b2-e26f962423cd/0/0 | Easy Authenticator | Time-based One-time Password (TOTP), Support for Multiple apps like Google Authenticator or Microsoft Authenticator etc. | 9 | verify | Validate TOTP | 200 | Example | {"verify": true, "error": ""} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"verify": {"type": "boolean"}, "error": {"type": "string"}}, "required": ["error", "verify"]} |
6fa93768-8f11-4c58-8942-f81948358d38/a38315bd-95c2-41b2-b409-15d5b8ed65c5/0/0 | Easy Authenticator | Time-based One-time Password (TOTP), Support for Multiple apps like Google Authenticator or Microsoft Authenticator etc. | 9 | newAuthKey | Generate Secretkey and QR code | 200 | New Example | {"secretCode": "XXXXXX", "imageData": "data:image/png;base64,iVBOR..."} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"secretCode": {"type": "string"}, "imageData": {"type": "string"}}, "required": ["imageData", "secretCode"]} |
ccbdce6c-cab5-47d5-8d0d-761cd54ba3b6/4d03feb3-842a-41f5-ae61-9d54161a9a85/0/0 | UniPhone Verify | this API verify if this phone have any financial history in real-time. | 8.8 | VERIFY | allow you to verify phone number (only support US phone numbers at the time.) | 400 | New Example | {"status": "recheck", "unrecognised": "unrecognised"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "unrecognised": {"type": "string"}}, "required": ["status", "unrecognised"]} |
ccbdce6c-cab5-47d5-8d0d-761cd54ba3b6/4d03feb3-842a-41f5-ae61-9d54161a9a85/1/0 | UniPhone Verify | this API verify if this phone have any financial history in real-time. | 8.8 | VERIFY | allow you to verify phone number (only support US phone numbers at the time.) | 200 | Success Response | {"status": "value", "captcha-name": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "captcha-name": {"type": "string"}}, "required": ["captcha-name", "status"]} |
69309435-9740-4f83-a736-1599cff573e9/241f9dc5-cab7-407b-814d-c3bd8e0bddea/0/0 | Friendchatik | SMS verification api | null | FriendchatSMS | Friendchat SMS Sender | 130 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/5665cc56-af66-41a1-94a1-111df11015d6/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Get messages | Fetch paginated messages.
Please note that the messages will be sorted by the date of creating (sending) - latest first. | 200 | Response | {"current_page": 1, "data": [], "first_page_url": "https://api.sms.to/messages?page=1", "from": null, "last_page": 1, "last_page_url": "https://api.sms.to/messages?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "https://api.sms.to/messages?page=1", "label": "1", "active": tru... | {"type": "object", "properties": {"current_page": {"type": "integer"}, "data": {"type": "array"}, "first_page_url": {"type": "string"}, "from": {"type": "null"}, "last_page": {"type": "integer"}, "last_page_url": {"type": "string"}, "links": {"type": "array", "items": {"type": "object"}}, "next_page_url": {"type": "nul... |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/2ca58452-78df-44b2-862f-9aa176b879ad/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Estimate campaign message | Estimate the cost of sending message to multiple recipients (phone numbers) | 200 | Response | {"estimated_cost": 0.02, "contact_count": 2, "invalid_count": 0, "sms_count": 1, "errors": []} | {"type": "object", "properties": {"estimated_cost": {"type": "number"}, "contact_count": {"type": "integer"}, "invalid_count": {"type": "integer"}, "sms_count": {"type": "integer"}, "errors": {"type": "array"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/3f5c2f0d-025a-4749-970e-5528463d3ab4/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Estimate single message | Estimate the cost of sending single message | 200 | Response | {"sms_count": 1, "estimated_cost": 0.01, "contact_count": 1, "invalid_count": 0, "errors": []} | {"type": "object", "properties": {"sms_count": {"type": "integer"}, "estimated_cost": {"type": "number"}, "contact_count": {"type": "integer"}, "invalid_count": {"type": "integer"}, "errors": {"type": "array"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/294a4c5f-104b-4b82-ab0a-76bc98c5a6a0/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Get last campaign | Get the last campaign that you have sent | 200 | Response | {"id": 3682696, "_id": "11ed-0723-1deccd0a-b385-0242ac120004", "type": "sms", "user_id": 7243, "sender_id": "SMSto", "template_id": null, "message": "This is test", "list_id": null, "status": "SCHEDULED", "client_total_cost": 0, "estimated_cost": 0, "delivered_messages": 0, "failed_messages": 0, "pending_messages": 2, ... | {"type": "object", "properties": {"id": {"type": "integer"}, "_id": {"type": "string"}, "type": {"type": "string"}, "user_id": {"type": "integer"}, "sender_id": {"type": "string"}, "template_id": {"type": "null"}, "message": {"type": "string"}, "list_id": {"type": "null"}, "status": {"type": "string"}, "client_total_co... |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/9dbd7080-7147-4f32-8d15-f142ed1f7890/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Schedule sending messages | Schedule messages to send later
This is the same as Send personalized messages, but scheduled_for and timezone parameters are additionally specified.
Please note that if you do not provide the timezone parameter, then timezone from your SMS.to account settings will be used.
If you did not set the timezone (on your acco... | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "campaign_id": "11ed-0722-e4feb47c-9c5b-0242ac120008"} | {"type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "campaign_id": {"type": "string"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/89ec9300-5bfb-4c13-8def-4933bff5b893/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Send flash message | Send flash message to a number | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "message_id": "11ed-072a-d324d4c2-bb8f-02420a000287"} | {"type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "message_id": {"type": "string"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/c442b2cc-56e7-44c6-8ccb-6509a3e3a087/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Send viber message | Send viber message to a number | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "message_id": "11ed-072c-094a82bc-a6e3-02420a000287"} | {"type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "message_id": {"type": "string"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/9b024744-69b3-4def-87f2-feb1f252fedd/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Get message by id | Get the message that you have sent by ID | 200 | Response | {"id": "11ed-072c-2e295590-89fe-02420a000287", "campaign_id": null, "sender_id": "SMSto", "message": "This is a test message", "to": "+35799999999999", "status": "REJECTED", "cost": 0, "sms_count": 1, "type": "viber", "callback_url": "https://example.com/callback/handler", "scheduled_for": null, "timezone": null, "upda... | {"type": "object", "properties": {"id": {"type": "string"}, "campaign_id": {"type": "null"}, "sender_id": {"type": "string"}, "message": {"type": "string"}, "to": {"type": "string"}, "status": {"type": "string"}, "cost": {"type": "integer"}, "sms_count": {"type": "integer"}, "type": {"type": "string"}, "callback_url": ... |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/1e9e18f1-fe17-4ce5-bf1a-7351cbd47ca9/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Send campaign message | Send message to multiple recipients (phone numbers) | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "campaign_id": "11ed-071b-815e933a-bfe0-0242ac120004"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "campaign_id": {"type": "string"}}, "required": ["campaign_id", "message", "success"]} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/37abcd6a-4d7c-4c92-8281-532f2b949dec/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Send personalized messages | Send personalized messages | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "campaign_id": "11ed-071f-9e08ec98-8059-0242ac120004"} | {"type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "campaign_id": {"type": "string"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/b7faa628-e373-42a6-b9c4-5ae309ff51cf/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Send Message to a list or multiple list in array | Send Message to a list or multiple list in array | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "campaign_id": "11ed-071c-3bd2a1b6-a974-0242ac120008"} | {"type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "campaign_id": {"type": "string"}}} |
d3f33ac6-7289-4f95-8fa3-0cc4dbc93e11/6a6aac0b-f0a7-4087-b9a9-50b4d2c6a5a1/0/0 | SMSto | Implement SMS notifications, OTP, reminders, etc. into your workflow and build apps that send SMS with our redundant SSL SMS API. | 0.3 | Send single message | Send a single message to a number | 200 | Response | {"message": "Message is queued for sending! Please check report for update", "success": true, "message_id": "11ed-0719-3e6b8882-b76f-02420a000287"} | {"type": "object", "properties": {"message": {"type": "string"}, "success": {"type": "boolean"}, "message_id": {"type": "string"}}} |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/58303da7-0353-4bc6-88aa-1ac99c7901b4/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Home Location Register | Retrieves Home Location Register information for a given phone number. | 200 | Response | {"country_code": "DE", "country_name": "Germany", "country_prefix": "49", "current_carrier": {"country": "DE", "name": "Telef\u00f3nica Germany GmbH & Co. oHG (O2)", "network_code": "26203", "network_type": "mobile"}, "gsm_code": "0", "gsm_message": "No error", "international_format_number": "491771783130", "internatio... | {"definitions": {"carrier": {"properties": {"country": {"type": "string"}, "name": {"type": "string"}, "network_code": {"type": "string"}, "network_type": {"type": "string"}}, "required": ["network_code", "name", "country", "network_type"], "type": "object"}}, "properties": {"country_code": {"type": "string"}, "country... |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/84f75992-a32c-4d56-897f-8297dc12265d/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Caller Name Delivery | Retrieves Calling Name Delivery information for a phone number. | 200 | Response | {"code": "100", "name": "GERMANY", "number": "+491771783130", "success": "true"} | {"properties": {"code": {"type": "string"}, "name": {"type": "string"}, "number": {"type": "string"}, "success": {"pattern": "\\b(false|true)", "type": "string"}}, "type": "object"} |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/c3ccafd2-25bb-43fc-9520-80878038cc04/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Mobile Number Portability | Retrieves Mobile Number Portability information for a given phone number. | 200 | JsonResponse | {"code": 100, "mnp": {"country": "DE", "international_formatted": "+49 177 1783130", "isPorted": false, "mccmnc": "26203", "national_format": "0177 1783130", "network": "Telef\u00f3nica Germany GmbH & Co. oHG (O2)", "number": "+491771783130"}, "price": 0.005, "success": true} | {"properties": {"code": {"minimum": 100, "type": "integer"}, "mnp": {"properties": {"country": {"type": "string"}, "international_formatted": {"type": "string"}, "isPorted": {"type": "boolean"}, "mccmnc": {"type": "string"}, "national_format": {"type": "string"}, "network": {"type": "string"}, "number": {"type": "strin... |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/8af8b4d1-9ff8-4ba0-9945-5c0309bd6484/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Get Pricing | Retrieves pricing information for a single country or all. | 200 | Response | {"countCountries": 1, "countNetworks": 27, "countries": [{"countryCode": "DE", "countryName": "Germany", "countryPrefix": "49", "networks": [{"comment": "", "features": [], "mcc": "262", "mncs": ["15"], "networkName": " (Airdata)", "price": 0.075}, {"comment": "", "features": [], "mcc": "262", "mncs": ["42"], "networkN... | {"properties": {"countCountries": {"minimum": 0, "type": "integer"}, "countNetworks": {"minimum": 0, "type": "integer"}, "countries": {"items": {"properties": {"countryCode": {"type": "string"}, "countryName": {"minLength": 1, "type": "string"}, "countryPrefix": {"type": "string"}, "networks": {"items": {"properties": ... |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/6543684d-e16e-4ce7-a90e-b89fa053eb51/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Create Webhook | Creates a webhook with the given configuration. | 200 | Error | {"success": false} | {"properties": {"id": {"type": "number"}, "success": {"type": "boolean"}}, "required": ["success"], "type": "object"} |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/6543684d-e16e-4ce7-a90e-b89fa053eb51/0/1 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Create Webhook | Creates a webhook with the given configuration. | 200 | Success | {"id": 1234567890, "success": false} | {"properties": {"id": {"type": "number"}, "success": {"type": "boolean"}}, "required": ["success"], "type": "object"} |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/8e5b884d-bd67-48b4-b7c7-296619a20048/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Delete Webhook | Deletes the webhook with the given ID. | 200 | Response | {"success": true} | {"properties": {"success": {"type": "boolean"}}, "type": "object"} |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/343ce722-0e1f-496e-b097-bbc09934a130/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Number Format Lookup | Retrieves the network operator as well as additional (porting) information for the given phone number. | 200 | SuccessResponse | {"carrier": "Eplus", "country_code": "49", "country_iso": "DE", "country_name": "Germany", "international": "+491771783130", "international_formatted": "+49 177 1783130", "national": "0177 1783130", "network_type": "mobile", "success": true} | {"properties": {"carrier": {"type": "string"}, "country_code": {"type": "string"}, "country_iso": {"type": "string"}, "country_name": {"type": "string"}, "international": {"type": "string"}, "international_formatted": {"type": "string"}, "national": {"type": "string"}, "network_type": {"type": "string"}, "success": {"t... |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/dadcc165-11bc-4126-98b9-71094be8f630/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Get Analytics | Get detailed statistics of your account directly through our API. | 200 | Response | [{"date": "2020-10-06", "direct": 2, "economy": 0, "hlr": 0, "inbound": 0, "mnp": 0, "usage_eur": 0.15, "voice": 0}, {"date": "2020-10-07", "direct": 2, "economy": 0, "hlr": 0, "inbound": 0, "mnp": 0, "usage_eur": 0.15, "voice": 0}, {"date": "2020-10-08", "direct": 14, "economy": 0, "hlr": 3, "inbound": 0, "mnp": 9, "u... | {"items": {"properties": {"date": {"format": "date", "type": "string"}, "direct": {"minimum": 0, "type": "integer"}, "economy": {"minimum": 0, "type": "integer"}, "hlr": {"minimum": 0, "type": "integer"}, "inbound": {"minimum": 0, "type": "integer"}, "mnp": {"minimum": 0, "type": "integer"}, "usage_eur": {"type": "numb... |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/595e32b5-bf4e-4e00-965b-d0c3806d5f2c/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Get Webhooks | Retrieves all existing webhooks. | 200 | Response | {"code": null, "hooks": [{"created": "2020-11-04 23:33:08", "event_type": "voice_status", "id": "31", "request_method": "POST", "target_url": "http://my.tld/webhook1"}, {"created": "2020-11-05 10:02:02", "event_type": "voice_status", "id": "33", "request_method": "GET", "target_url": "http://my.tld/hook1604566922721"},... | {"properties": {"hooks": {"items": {"properties": {"created": {"type": "string"}, "event_type": {"pattern": "\\b(sms_mo|dlr|voice_status)", "type": "string"}, "id": {"minLength": 1, "type": "string"}, "request_method": {"pattern": "\\b(GET|POST)", "type": "string"}, "target_url": {"type": "string"}}, "type": "object"},... |
6f27c0fa-cd65-4b6a-9828-92e11b6efba9/55798b5a-8f4c-4dfa-8e9d-329495d374c6/0/0 | sms77io | Send SMS & text-to-speech messages, perform phone number lookups and much more via seven.io. | 9.3 | Validate Caller ID | The caller ID validation API allows you to automatically validate caller IDs for the Voice API. After calling this endpoint you will get a code back if successful. At the same time, the phone number is going to receive a call from us. The returned code must then be entered via DTMF using the telephone’s keypad. | 200 | Response | {"code": "699350", "error": null, "success": true} | {"properties": {"error": {"minLength": 1, "type": ["string", "null"]}, "formatted_output": {"minLength": 1, "type": ["string", "null"]}, "id": {"minimum": 0, "type": ["integer", "null"]}, "sender": {"minLength": 1, "type": "string"}, "success": {"type": "boolean"}, "voice": {"type": "boolean"}}, "required": ["success"]... |
9cca683e-af71-4ec1-ac2e-0728e0be50f3/2046bdf9-6176-40a6-a1ff-b83b0082eeea/0/0 | Otp sms verification | send otp verification code to any number and verify otp code | null | verify code | verify code that has been sent using send code api | 200 | Response | {"status": "approved"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}}, "required": ["status"]} |
9cca683e-af71-4ec1-ac2e-0728e0be50f3/6d83a9d0-13fa-4e00-bc42-a684b047f42f/0/0 | Otp sms verification | send otp verification code to any number and verify otp code | null | send sms | send otp verification code to number | 200 | Response | {"status": "pending"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}}, "required": ["status"]} |
08db7794-3d4e-4a51-a6b7-dbeb8d50c729/eb96dcaf-3665-4c63-9911-e6db773dc232/0/0 | Go-Messenger | "Rev up your messaging game with the LightningChat API – the Usain Bolt of Golang APIs! 🚀 Send, receive, and manage SMS faster than ever before. | 5.4 | Send Message | a simple body tag is all you need to send message. | 200 | New Example | {"message": "New Message Created Successfully"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]} |
08db7794-3d4e-4a51-a6b7-dbeb8d50c729/06f33fe2-447e-48c0-bb8e-8ac6bfbbb4f7/0/0 | Go-Messenger | "Rev up your messaging game with the LightningChat API – the Usain Bolt of Golang APIs! 🚀 Send, receive, and manage SMS faster than ever before. | 5.4 | Delete User Message | delete a user's message by using user id. | 200 | New Example | {"message": "Message deleted successfully"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]} |
08db7794-3d4e-4a51-a6b7-dbeb8d50c729/a0ed9a12-dd60-4716-b13e-2987dba55ae4/0/0 | Go-Messenger | "Rev up your messaging game with the LightningChat API – the Usain Bolt of Golang APIs! 🚀 Send, receive, and manage SMS faster than ever before. | 5.4 | Read Single Message using user ID | read a message using user id. | 200 | New Example | {"id": "c283a600-8555-439f-8959-869203bc58d6", "body": "A Message"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"id": {"type": "string"}, "body": {"type": "string"}}, "required": ["body", "id"]} |
08db7794-3d4e-4a51-a6b7-dbeb8d50c729/2ba30200-871d-44e8-98b5-19344350f509/0/0 | Go-Messenger | "Rev up your messaging game with the LightningChat API – the Usain Bolt of Golang APIs! 🚀 Send, receive, and manage SMS faster than ever before. | 5.4 | Read All Messages | Read all messages of the user. | 200 | New Example | {"message": "New Message Created Successfully"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]} |
5516ff83-d467-4d25-9daa-acf38c646c2e/6a27d4fc-875b-46ce-8fab-74393e738a8d/0/0 | CO2 Offset | GreenHouseGas/CO2 compensation as a service. Get 1kg/month for free to see how easy it is to implement. | 7.6 | Retrieve Compensation | Response contains full compensation details (if exists, and owner is account). | 200 | OwnerView | {"id": "0xF0F2e446EeD32236EA0c78a6E4a91Ed712654799", "ancestor": {"organization": "Plant-For-The-Planet", "externalId": "GS1-1-TR-GS947-12-2013-3896-62367", "id": "0x5001959a7Cad5eDD6beF1689a0b7833173af54cB", "type": "Double Impact", "co2eq": 82872104}, "sibbling": {"goldstandardcredit": {"organization": "Gold Standard... | {"type": "object", "properties": {"id": {"type": "string"}, "ancestor": {"type": "object", "properties": {"organization": {"type": "string"}, "externalId": {"type": "string"}, "id": {"type": "string"}, "type": {"type": "string"}, "co2eq": {"type": "integer"}}}, "sibbling": {"type": "object", "properties": {"goldstandar... |
5516ff83-d467-4d25-9daa-acf38c646c2e/6a27d4fc-875b-46ce-8fab-74393e738a8d/1/0 | CO2 Offset | GreenHouseGas/CO2 compensation as a service. Get 1kg/month for free to see how easy it is to implement. | 7.6 | Retrieve Compensation | Response contains full compensation details (if exists, and owner is account). | 404 | Certificate not found | {"err": "Compensation certificate not found."} | {"type": "object", "properties": {"err": {"type": "string"}}} |
5516ff83-d467-4d25-9daa-acf38c646c2e/6a27d4fc-875b-46ce-8fab-74393e738a8d/2/0 | CO2 Offset | GreenHouseGas/CO2 compensation as a service. Get 1kg/month for free to see how easy it is to implement. | 7.6 | Retrieve Compensation | Response contains full compensation details (if exists, and owner is account). | 403 | New Example | {"err": "Compensation exists - but is not yours."} | {"type": "object", "properties": {"err": {"type": "string"}}} |
5516ff83-d467-4d25-9daa-acf38c646c2e/f5a7bcb0-bdb6-45d3-a256-8aecbee1616d/0/0 | CO2 Offset | GreenHouseGas/CO2 compensation as a service. Get 1kg/month for free to see how easy it is to implement. | 7.6 | Compensate GHG/CO2 | Compensate given amount of GHG/CO2eq and provides certificate reference as result.
| 200 | New Example | {"ancestor": {"organization": "Plant-For-The-Planet", "externalId": "GS1-1-TR-GS947-12-2013-3896-62367", "id": "0x5001959a7Cad5eDD6beF1689a0b7833173af54cB", "type": "Double Impact", "co2eq": 82872110}, "sibbling": {"goldstandardcredit": {"tx": {"txid": "0x16e8BeDC0A7e8Be504e60d62DcbbFF92f7Cd3562", "from": "0x5001959a7C... | {"type": "object", "properties": {"ancestor": {"type": "object", "description": "Parent certificate / offset this compensation is part of.", "properties": {"organization": {"type": "string"}, "externalId": {"type": "string"}, "id": {"type": "string"}, "type": {"type": "string"}, "co2eq": {"type": "integer"}}}, "sibblin... |
a986429e-92be-4c32-a305-e0ec7ce7d2c4/c8ee2c73-acfe-4288-878a-7a0b7f7533ac/1/0 | energy Optimizer | Provides cheapest electricity hours (considering electricity and transport) in NordPool Baltics area. Can use this to schedule your time-shiftable energy consumption like floor heating and water boilers or electric car charging. | null | Get hours_available | Returns : json of chepaest hours info, for future time interval
Parameters:
country - one of supported 2-letter formats
count - number of hours to return
start_time - ISO formatted with time offset, like 2022-11-28T18:00:00+02:00, default next hour
end_time - ISO formatted with time offset, like 2022-11-28T18:00:00+02... | 422 | Example_1 | {"detail": [{"loc": [], "msg": "", "type": ""}]} | {"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "inte... |
a986429e-92be-4c32-a305-e0ec7ce7d2c4/888c81e6-7306-4241-b6da-34fe033ebc60/0/0 | energy Optimizer | Provides cheapest electricity hours (considering electricity and transport) in NordPool Baltics area. Can use this to schedule your time-shiftable energy consumption like floor heating and water boilers or electric car charging. | null | Get hours | Returns : json of chepaest hours, for full periods (past time included), depending period parameter
Parameters:
country - one of supported 2-letter formats
count - number of hours to return
period - may be one of 0 - today (default), 1 - tomorrow, 2 - today and tomorrow | 422 | Example_1 | {"detail": [{"loc": [], "msg": "", "type": ""}]} | {"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "inte... |
8a633727-9544-4879-a8c5-4b6df59e4c29/dfd253f7-1812-4334-b0b6-f177a552f011/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getHealthChargerVendors | Lists the available charger vendors. If you authenticate with a client or link token we also show the vendors that your client has beta access to. | 200 | null | [{"vendor": "EASEE", "displayName": "Easee", "status": "READY"}, {"vendor": "WALLBOX", "displayName": "Wallbox", "status": "READY"}, {"vendor": "ZAPTEC", "displayName": "Zaptec", "status": "READY"}, {"vendor": "EO", "displayName": "EO", "status": "READY"}] | {"type": "array", "items": {"type": "object", "properties": {"vendor": {"type": "string", "title": "Charger Vendor", "description": "Charger Vendor", "enum": ["ZAPTEC", "EASEE", "WALLBOX", "EO", "CHARGEAMPS", "EVBOX"]}, "displayName": {"type": "string", "description": "A formatted and properly cased vendor brand name, ... |
8a633727-9544-4879-a8c5-4b6df59e4c29/039184a5-c143-48ed-929a-2102e0c37e58/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | postCharginglocations | 201 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "name": "Home", "longitude": 10.757933, "latitude": 59.911491, "timezoneName": "Europe/Copenhagen"} | {"type": "object", "required": ["id", "name", "longitude", "latitude"], "properties": {"id": {"type": "string", "format": "uuid", "description": "Charging Location ID"}, "name": {"type": "string", "description": "User-supplied name for the Charging Location", "default": "<string>"}, "longitude": {"type": "number", "des... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/5c7777ea-3627-4f21-a984-ae1a383f8cea/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getVehiclesAction | Returns the current state of the requested action. | 200 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "targetId": {"0": "8", "1": "d", "2": "9", "3": "0", "4": "1", "5": "0", "6": "1", "7": "b", "8": "3", "9": "f", "10": "2", "11": "f"}, "targetType": "vehicle", "kind": "START", "createdAt": "2020-04-07T17:04:26Z", "updatedAt": "2020-04-07T17:04:26Z", "completedAt": "2020-... | {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "targetId": {"allOf": [{"type": "string", "minLength": 1}, {"type": "string", "description": "ID of the chargeable entity asset (Vehicle or Charger) which this action is controlling."}]}, "targetType": {"type": "string", "enum": ["vehicle", "... |
8a633727-9544-4879-a8c5-4b6df59e4c29/fde11313-cfbe-4805-bcbe-bd2f148fafb0/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getVehiclesVehicleidSmartchargingpolicy | Get a vehicle's Smart Charging policy | 200 | null | {"isEnabled": "<boolean>", "deadline": "08:00"} | {"type": "object", "description": "[Smart Charging](/docs/smart-charging/introduction) configuration properties. Configured via the [Update Smart Charging Policy](/api/reference#updateVehicleSmartChargingPolicy) endpoint.", "properties": {"isEnabled": {"type": "boolean", "description": "When enabled, this vehicle's cha... |
8a633727-9544-4879-a8c5-4b6df59e4c29/fc38c8e9-24e9-4ee2-84d4-5bdf32a29716/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getStatisticsProduction | Returns a normalized time series of statistics about power production and price for the User. | 200 | null | [{"kw": {"min": 0, "max": 78, "mean": 61}, "kwhSum": 120, "price": {"min": 13.8, "max": 14.4, "mean": 14.1}, "earningsSum": 3.14, "date": "2021-01-19T09:37:36.845Z"}] | {"type": "array", "items": {"type": "object", "properties": {"kw": {"type": "object", "description": "Aggregate statistics for charge rate in kW", "properties": {"min": {"type": "number"}, "max": {"type": "number"}, "mean": {"type": "number"}}, "required": ["min", "max", "mean"]}, "kwhSum": {"type": "number", "descript... |
8a633727-9544-4879-a8c5-4b6df59e4c29/1a47008c-b086-4c3c-9038-5558071b26ee/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getCharginglocations | Returns a list of Charging Locations registered to the User | 200 | null | [{"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "name": "Home", "longitude": 10.757933, "latitude": 59.911491, "timezoneName": "Europe/Copenhagen"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "longitude", "latitude"], "properties": {"id": {"type": "string", "format": "uuid", "description": "Charging Location ID"}, "name": {"type": "string", "description": "User-supplied name for the Charging Location", "default": "<string>"}, "longitud... |
8a633727-9544-4879-a8c5-4b6df59e4c29/8dd5769a-5092-41f2-82ca-cae03646e224/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getVehiclesVehicleid | 200 | null | {"id": "", "vendor": "TESLA", "lastSeen": "", "isReachable": true, "chargingLocationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "information": {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "vin": "5YJYGDEF2LFR00942", "brand": "Tesla", "model": "Model S P85", "year": 2020}, "chargeState": {"batteryLevel": 38, "range":... | {"type": "object", "properties": {"id": {"type": "string", "description": "Vehicle ID"}, "vendor": {"type": "string", "title": "Vehicle Vendor", "description": "Vehicle Vendor", "enum": ["AUDI", "BMW", "HONDA", "HYUNDAI", "JAGUAR", "KIA", "MERCEDES", "MINI", "NISSAN", "PEUGEOT", "PORSCHE", "RENAULT", "SEAT", "SKODA", "... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/63ada185-c1a2-4dff-a2e0-2579ea606ae4/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | putCharginglocationsCharginglocationid | Updates a charging location with new configuration. | 200 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "name": "Home", "longitude": 10.757933, "latitude": 59.911491, "timezoneName": "Europe/Copenhagen"} | {"type": "object", "required": ["id", "name", "longitude", "latitude"], "properties": {"id": {"type": "string", "format": "uuid", "description": "Charging Location ID"}, "name": {"type": "string", "description": "User-supplied name for the Charging Location", "default": "<string>"}, "longitude": {"type": "number", "des... |
8a633727-9544-4879-a8c5-4b6df59e4c29/da07a8a2-e56b-43aa-9694-756b4e34c4ab/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | updateHVAC | Update the chargingLocationId field on an HVAC device. | 200 | null | {"mode": {"0": "H", "1": "E", "2": "A", "3": "T"}, "heatSetpoint": 22, "coolSetpoint": 24, "holdType": "PERMANENT", "id": "8f39fa8d-8f10-4984-a319-741dc23848c0", "vendor": {"0": "A", "1": "D", "2": "A", "3": "X"}, "lastSeen": "2020-04-07T17:04:26Z", "isReachable": true, "chargingLocationId": "8d90101b-3f2f-462a-bbb4-1e... | {"type": "object", "required": ["id", "lastSeen", "isReachable"], "allOf": [{"type": "object", "description": "Target mode for an HVAC device", "required": ["mode", "holdType"], "properties": {"mode": {"allOf": [{"type": "string", "enum": ["HEAT", "COOL", "AUTO", "OFF"], "description": "HVAC Mode"}, {"type": "string", ... |
8a633727-9544-4879-a8c5-4b6df59e4c29/9469cbf2-9022-4f7c-81dd-efbaca4269d0/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getHVAC | 200 | null | {"mode": {"0": "H", "1": "E", "2": "A", "3": "T"}, "heatSetpoint": 22, "coolSetpoint": 24, "holdType": "PERMANENT", "id": "8f39fa8d-8f10-4984-a319-741dc23848c0", "vendor": {"0": "A", "1": "D", "2": "A", "3": "X"}, "lastSeen": "2020-04-07T17:04:26Z", "isReachable": true, "chargingLocationId": "8d90101b-3f2f-462a-bbb4-1e... | {"type": "object", "required": ["id", "lastSeen", "isReachable"], "allOf": [{"type": "object", "description": "Target mode for an HVAC device", "required": ["mode", "holdType"], "properties": {"mode": {"allOf": [{"type": "string", "enum": ["HEAT", "COOL", "AUTO", "OFF"], "description": "HVAC Mode"}, {"type": "string", ... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/d89f193b-5920-4152-bc0e-732c81d32376/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | postSetHvacPermanentHold | Tell an HVAC unit to enter a permanent hold. Only available if PERMANENT is present in the target's capabilities.capableHoldType. We retry sending the command until the HVAC unit's target field transition to the expected value. Note that this request will complete before any commands are sent to the HVAC unit. You may ... | 422 | null | {"type": "", "title": "", "detail": ""} | {"type": "object", "title": "Problem", "description": "Standard Problem Error", "properties": {"type": {"type": "string"}, "title": {"type": "string"}, "detail": {"type": "string"}}} |
8a633727-9544-4879-a8c5-4b6df59e4c29/d89f193b-5920-4152-bc0e-732c81d32376/1/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | postSetHvacPermanentHold | Tell an HVAC unit to enter a permanent hold. Only available if PERMANENT is present in the target's capabilities.capableHoldType. We retry sending the command until the HVAC unit's target field transition to the expected value. Note that this request will complete before any commands are sent to the HVAC unit. You may ... | 200 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "targetId": {"0": "8", "1": "d", "2": "9", "3": "0", "4": "1", "5": "0", "6": "1", "7": "b", "8": "3", "9": "f", "10": "2", "11": "f"}, "targetType": "hvac", "targetTemperature": {"temperature": 22, "deadband": 4}, "target": {"mode": {"0": "H", "1": "E", "2": "A", "3": "T"... | {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "targetId": {"allOf": [{"type": "string", "minLength": 1}, {"type": "string", "description": "ID of the entity asset (HVAC) which this action is controlling."}]}, "targetType": {"type": "string", "enum": ["hvac"]}, "targetTemperature": {"type... |
8a633727-9544-4879-a8c5-4b6df59e4c29/5f494e94-de36-4f7b-a9fe-604c370fe37d/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getHvacsAction | Returns the current state of the requested action. | 200 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "targetId": {"0": "8", "1": "d", "2": "9", "3": "0", "4": "1", "5": "0", "6": "1", "7": "b", "8": "3", "9": "f", "10": "2", "11": "f"}, "targetType": "hvac", "targetTemperature": {"temperature": 22, "deadband": 4}, "target": {"mode": {"0": "H", "1": "E", "2": "A", "3": "T"... | {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "targetId": {"allOf": [{"type": "string", "minLength": 1}, {"type": "string", "description": "ID of the entity asset (HVAC) which this action is controlling."}]}, "targetType": {"type": "string", "enum": ["hvac"]}, "targetTemperature": {"type... |
8a633727-9544-4879-a8c5-4b6df59e4c29/a2992a90-d9e2-4441-a257-194560b6c61e/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getHealthInverterVendors | Lists the available inverter vendors. If you authenticate with a client or link token we also show the vendors that your client has beta access to. | 200 | null | [{"vendor": "SOLAREDGE", "displayName": "Solar Edge", "status": "READY"}, {"vendor": "SMA", "displayName": "SMA", "status": "READY"}, {"vendor": "SOLIS", "displayName": "Solis", "status": "READY"}, {"vendor": "FRONIUS", "displayName": "Fronius", "status": "READY"}] | {"type": "array", "items": {"type": "object", "properties": {"vendor": {"type": "string", "title": "Inverter Vendor", "description": "Inverter Vendor", "enum": ["FRONIUS", "GROWATT", "SOLAREDGE", "SOLIS"]}, "displayName": {"type": "string", "description": "A formatted and properly cased vendor brand name, suitable for ... |
8a633727-9544-4879-a8c5-4b6df59e4c29/0b2e6524-4583-4fec-8b73-0c6c7e8ac4e6/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getHealthHvacVendors | Lists the available HVAC vendors. If you authenticate with a client token we also show the vendors that your client has beta access to. | 200 | null | [{"vendor": "MILL", "displayName": "Mill", "portalName": "Mill", "status": "READY"}] | {"type": "array", "items": {"type": "object", "properties": {"vendor": {"type": "string", "title": "HVAC Vendor", "description": "HVAC Vendor", "enum": ["TADO", "MILL", "ADAX", "ECOBEE", "SENSIBO", "HONEYWELL", "MITSUBISHI"]}, "displayName": {"type": "string", "description": "A formatted and properly cased vendor brand... |
8a633727-9544-4879-a8c5-4b6df59e4c29/43903041-eb84-4236-83a4-d41caede2f69/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getCharginglocationsCharginglocationid | 200 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "name": "Home", "longitude": 10.757933, "latitude": 59.911491, "timezoneName": "Europe/Copenhagen"} | {"type": "object", "required": ["id", "name", "longitude", "latitude"], "properties": {"id": {"type": "string", "format": "uuid", "description": "Charging Location ID"}, "name": {"type": "string", "description": "User-supplied name for the Charging Location", "default": "<string>"}, "longitude": {"type": "number", "des... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/391267d6-b160-4ffa-a8d1-ef4bf4d74adf/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getHealthVehicleVendors | Lists the available vehicle vendors. If you authenticate with a client or link token we also include the vendors that your client has beta access to. | 200 | null | [{"vendor": "TESLA", "displayName": "Tesla", "status": "READY"}, {"vendor": "BMW", "displayName": "BMW", "status": "READY"}, {"vendor": "AUDI", "displayName": "Audi", "status": "READY"}] | {"type": "array", "items": {"type": "object", "properties": {"vendor": {"type": "string", "title": "Vehicle Vendor", "description": "Vehicle Vendor", "enum": ["AUDI", "BMW", "HONDA", "HYUNDAI", "JAGUAR", "KIA", "MERCEDES", "MINI", "NISSAN", "PEUGEOT", "PORSCHE", "RENAULT", "SEAT", "SKODA", "TESLA", "VOLKSWAGEN", "VOLVO... |
8a633727-9544-4879-a8c5-4b6df59e4c29/cc6e3999-b8a7-415d-9955-170c88823c53/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | updateVehicleSmartChargingPolicy | Updates the Smart Charging policy for a vehicle | 200 | null | {"isEnabled": "<boolean>", "deadline": "08:00"} | {"type": "object", "description": "[Smart Charging](/docs/smart-charging/introduction) configuration properties. Configured via the [Update Smart Charging Policy](/api/reference#updateVehicleSmartChargingPolicy) endpoint.", "properties": {"isEnabled": {"type": "boolean", "description": "When enabled, this vehicle's cha... |
8a633727-9544-4879-a8c5-4b6df59e4c29/333872e2-03c6-4322-8cd6-65197009cab4/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getVehicles | List all available Vehicles for the User.
If you already know the ID of a vehicle you want to fetch, it is recommended to fetch it using the more performant Get Vehicle method. | 200 | null | [{"id": "", "vendor": "TESLA", "lastSeen": "", "isReachable": true, "chargingLocationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "information": {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "vin": "5YJYGDEF2LFR00942", "brand": "Tesla", "model": "Model S P85", "year": 2020}, "chargeState": {"batteryLevel": 38, "range"... | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "Vehicle ID"}, "vendor": {"type": "string", "title": "Vehicle Vendor", "description": "Vehicle Vendor", "enum": ["AUDI", "BMW", "HONDA", "HYUNDAI", "JAGUAR", "KIA", "MERCEDES", "MINI", "NISSAN", "PEUGEOT", "PORSCHE", "R... |
8a633727-9544-4879-a8c5-4b6df59e4c29/11802fe4-e024-42e9-b0d3-017da08d3715/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getInverter | 200 | null | {"id": "", "vendor": {"0": "S", "1": "O", "2": "L", "3": "I", "4": "S"}, "chargingLocationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "lastSeen": "2022-04-07T17:04:26Z", "isReachable": true, "productionState": {"productionRate": 1.8, "isProducing": true, "lastUpdated": "2022-04-07T16:21:76Z"}, "information": {"id": "8... | {"type": "object", "properties": {"id": {"type": "string", "description": "Solar inverter ID"}, "vendor": {"allOf": [{"type": "string", "title": "Inverter Vendor", "description": "Inverter Vendor", "enum": ["FRONIUS", "GROWATT", "SOLAREDGE", "SOLIS"]}, {"type": "string"}]}, "chargingLocationId": {"type": ["string", "nu... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/fcb9cbad-2ce4-4a91-9ec7-d8792cbcab29/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | postUsersUseridLink | Creates an Enode Link session attached to the provided User ID. If this User does not exist, it will be created. The returned linkState gives the User short-lived (24hs) access to Enode Link. A URL for Enode Link for the user to initiate asset linking is also returned. | 200 | null | {"linkState": "ZjE2MzMxMGFiYmU4MzcxOTU1ZmRjMTU5NGU2ZmE4YTU3NjViMzIwY2YzNG", "linkUrl": "https://link.production.enode.io?link_state=YzIwZThhYjYtMjMzMi00ZTAyLTg0OTYtYzdjOTlhZTY3Zjc3QDI2YzI1MDExLTdhYTctNGE2NS1iNjBmLTZmMzc5NmRhODUyMDowNDViYjFiYmE0M2Y5NDU5YTc5OTgxZmEyYTg1NmI4YzhkOGU4YjgyNmNmMzQzZmFmMGNhZTlmNDBjMmZmOTgy&req... | {"type": "object", "properties": {"linkState": {"type": "string"}, "linkUrl": {"type": "string"}}} |
8a633727-9544-4879-a8c5-4b6df59e4c29/a86615b9-db01-4a7c-86be-2dedea6abc40/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getVehiclesVehicleidSmartchargingstatus | Every vehicle in Enode has a SmartChargingStatus object that describes the vehicle in terms of smart charging. | 200 | null | {"updatedAt": "", "vehicleId": "", "userId": "", "vendor": "", "state": "DISABLED", "stateChangedAt": "", "consideration": {"isSmartChargeCapable": true, "isPluggedIn": true, "isCharging": true, "recentlyAtChargingLocation": true, "hasTimeEstimate": true, "confidentTimeEstimate": true, "needsSignificantCharge": true, "... | {"type": "object", "properties": {"updatedAt": {"type": "string", "format": "date-time", "description": "Time at which the SmartChargingStatus object was recalculated, whether or not any values actually changed"}, "vehicleId": {"type": "string", "description": "Vehicle ID"}, "userId": {"type": "string", "description": ... |
8a633727-9544-4879-a8c5-4b6df59e4c29/a1a19142-9655-434b-bb47-4c629c02f038/2/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getChargingLocationTariff | Get Tariff intervals for a given charging location. | 200 | null | [{"weekday": 0, "fromHourMinute": "00:00", "toHourMinute": "06:00", "tariffId": "testing-tariff-a", "tariffName": "OFF-PEAK"}, {"weekday": 0, "fromHourMinute": "06:00", "toHourMinute": "18:00", "tariffId": "testing-tariff-a", "tariffName": "PEAK"}] | {"type": "array", "description": "", "items": {"type": "object", "properties": {"weekday": {"type": "number"}, "fromHourMinute": {"type": "string"}, "toHourMinute": {"type": "string"}, "tariffId": {"type": "string"}, "tariffName": {"type": "string"}}}, "maxItems": 2} |
8a633727-9544-4879-a8c5-4b6df59e4c29/8c59079f-581c-44df-bc4f-38885f2698b5/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getSchedule | 200 | null | {"id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe"} | {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}}}, {"type": "object", "description": "A Schedule that applies to the combination of a certain Charging Location and chargeable asset (Vehicle/Charger/HVAC). Read the guide to [Using Schedules](/docs/scheduling).", "required": ["targ... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/53c1d45d-7638-4cea-932f-ed1d4aadde2d/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | getScheduleStatus | 200 | null | {"scheduleId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe", "changedAt": "", "state": "ALIGNED", "isCharging": true, "isChargingExpected": true, "isChargingExpectedParts": {"needsCharge": true, "isPluggedIn": true, "shouldCharge": true}, "upcomingTransitions": [{"at": "2020-04-07T17:04:26Z", "shouldCharge": true, "targetTem... | {"type": "object", "description": "", "required": ["scheduleId", "changedAt", "state", "isCharging", "isChargingExpected", "isChargingExpectedParts", "upcomingTransitions"], "properties": {"scheduleId": {"type": "string", "format": "uuid"}, "changedAt": {"type": "string", "format": "date-time", "description": "Time at ... | |
8a633727-9544-4879-a8c5-4b6df59e4c29/b2598792-1747-4958-9ba1-82456205e51e/0/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | vehicleEndExternalStart | Ends any active External Start for the vehicle specified by vehicleId. If previously configured, Schedules or Smart Charging will resume control over the target vehicle. Note that this does not mean the vehicle will stop charging, only that it will return to the state expected by the active Schedule or Smart Charging P... | 200 | null | {"createdAt": "2020-04-07T17:04:26Z", "endedAt": "2020-04-07T17:04:26Z", "targetType": "vehicle", "targetId": {"0": "8", "1": "d", "2": "9", "3": "0", "4": "1", "5": "0", "6": "1", "7": "b", "8": "3", "9": "f", "10": "2", "11": "f"}, "vendorActionId": ""} | {"type": ["object", "null"], "description": "This field is only populated after calling the [vehicle](/api/reference#vehicleCreateExternalStart) or [charger](/api/reference#chargerCreateExternalStart) External Start APIs. While this parameter is populated, the parent charge controller will remain in an overridden state... |
8a633727-9544-4879-a8c5-4b6df59e4c29/b2598792-1747-4958-9ba1-82456205e51e/1/0 | Enode API | A single API for hundreds of green energy devices. Easily connect to and control your customers’ electric vehicles, thermostats, solar panels, batteries and more. | null | vehicleEndExternalStart | Ends any active External Start for the vehicle specified by vehicleId. If previously configured, Schedules or Smart Charging will resume control over the target vehicle. Note that this does not mean the vehicle will stop charging, only that it will return to the state expected by the active Schedule or Smart Charging P... | 404 | null | {"type": "", "title": "", "detail": ""} | {"type": "object", "title": "Problem", "description": "Standard Problem Error", "properties": {"type": {"type": "string"}, "title": {"type": "string"}, "detail": {"type": "string"}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.