{"_id":"543f0f8f55bb10080009567e","is_link":false,"parentDoc":null,"editedParams":true,"githubsync":"","__v":2,"category":{"_id":"543ee0c055bb1008000955b6","__v":21,"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-15T21:01:52.185Z","from_sync":false,"order":1,"slug":"iwebcab-api-tools","title":"Gazoop Internal API"},"editedParams2":true,"project":"543005c87d487022005b3fa8","user":"543005a67d487022005b3fa7","version":{"_id":"543005c87d487022005b3fab","__v":6,"project":"543005c87d487022005b3fa8","createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-16T00:21:35.161Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"post","results":{"codes":[{"name":"Success","code":"{\n    \"result\": \"valid\"\n}","language":"json"},{"name":"Failure","code":"{\n    \"result\": \"error\"\n}","language":"json"}]},"try":true,"examples":{"codes":[]},"settings":"","auth":"never","params":[{"_id":"543f0f8f55bb100800095683","ref":"","in":"body","required":true,"desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","default":"","type":"string","name":"api_key"},{"_id":"543f0f8f55bb100800095682","ref":"","in":"body","required":true,"desc":"This is the mobile number for the customer account.","default":"","type":"int","name":"phone_number"},{"_id":"543f0f8f55bb100800095680","ref":"","in":"body","required":false,"desc":"You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.","default":"","type":"int","name":"customer_pin"},{"_id":"543f0f8f55bb10080009567f","ref":"","in":"body","required":true,"desc":"This is a text-based message that will be sent to the currently on-duty dispatcher for attention. This may be an internal dispatcher or an iWebCab Dispatcher depending on the email settings specified in \"Communications\".","default":"","type":"string","name":"message"}],"url":"/send_email.json"},"isReference":false,"order":14,"body":"This chapter describes how to send a message / email to the fleet dispatch by using the SEND_EMAIL command. This will automatically use the email address assigned to the customer account for responses, if appropriate.","excerpt":"This tool allows you to send an email in to dispatch without having to actually use a mail client. Any messages get placed directly in to the ticket system","slug":"send_email","type":"endpoint","title":"send_email"}

postsend_email

This tool allows you to send an email in to dispatch without having to actually use a mail client. Any messages get placed directly in to the ticket system

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

api_key:
required
string
This is a 25 alphanumeric hash code provided to you by the fleet.
phone_number:
required
integer
This is the mobile number for the customer account.
customer_pin:
integer
You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.
message:
required
string
This is a text-based message that will be sent to the currently on-duty dispatcher for attention. This may be an internal dispatcher or an iWebCab Dispatcher depending on the email settings specified in "Communications".

Result Format


Documentation

This chapter describes how to send a message / email to the fleet dispatch by using the SEND_EMAIL command. This will automatically use the email address assigned to the customer account for responses, if appropriate.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}