When requesting the API key, please provide us the following
Environment |
URL |
Test | http://apitest.mailvu.com/api/v1/manage |
Production | http://api.mailvu.com/api/v1/manage |
To Add/Remove Users you should call the above URL using HTTP protocol and pass the following parameters as POST or GET variables
Parameter name |
Type |
Description |
api-key |
Req |
ID of the partner. Given during setup by mailVU.
|
action |
Req |
ADDUSER: to add a user to the system |
user-id |
Req |
A unique ID (Unique for your account) that identifies a user |
timestamp |
Req |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Req |
hexdigest(MD5(action+api-key+user-id+timestamp+partner-secret-key)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
name |
opt |
Name of the user |
|
opt |
Email address of the user |
plan |
opt |
Plan used by the user. This will be required if your users get different limits per your contract with mailvu. Please contact support@mailvu.com to agree on the possible values for this field. |
security-level |
opt |
If your plan requires dashboard access instead of just widget, add this parameter to indicate proper security level Leave it empty for for Widgets only Possible Values:- BASEUSER USER ADMINISTRATOR |
signature |
Opt |
Signature text in HTML that will appear in the footer of the email and the landing page. |
icon1imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon1itemurl |
Opt |
URL for users social media account |
icon2imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon2itemurl |
Opt |
URL for users social media account |
icon3imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon3itemurl |
Opt |
URL for users social media account |
icon4imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon4itemurl |
Opt |
URL for users social media account |
icon5imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon5itemurl |
Opt |
URL for users social media account |
icon6imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon6itemurl |
Opt |
URL for users social media account |
template-code |
Opt |
specific to your account. Default mailvu-business |
template-logo-url |
Opt |
URL for the user’s logo. |
template-color1 |
Opt |
user defined field. Used to define color in the template |
template-color2 |
Opt |
user defined field. Used to define color in the template |
template-color3 |
Opt |
user defined field. Used to define color in the template |
template-color4 |
Opt |
user defined field. Used to define color in the template |
template-color5 |
Opt |
user defined field. Used to define color in the template |
template-color6 |
Opt |
user defined field. Used to define color in the template |
Value |
Description |
ok |
Action successful. User was added to the system |
Error 301 |
When certain required parameters are missing |
Error 304 |
When the hash generated by mailvu does not match the hash passed in the parameter. |
Error 321 |
User ID already exists in the system |
To change certain parameters of the user (plan/security etc.) you can call the endpoints with the following parameters:
Parameter name |
Type |
Description |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
action |
Req |
CHANGEUSER: to add a user to the system |
user-id |
Req |
A unique ID (Unique for your account) that identifies a user |
timestamp |
Req |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Req |
hexdigest(MD5(action+api-key+user-id+timestamp+partner-secret-key)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
name |
opt |
Name of the user |
|
opt |
Email address of the user |
plan |
opt |
Plan used by the user. This will be required if your users get different limits per your contract with mailvu. Please contact support@mailvu.com to agree on the possible values for this field. |
security-level |
optional |
If your plan requires dashboard access instead of just widget, add this parameter to indicate proper security level Leave it empty for for Widgets only Possible Values:- BASEUSER USER ADMINISTRATOR |
signature |
Opt |
Signature text in HTML that will appear in the footer of the email and the landing page. |
icon1imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon1itemurl |
Opt |
URL for users social media account |
icon2imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon2itemurl |
Opt |
URL for users social media account |
icon3imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon3itemurl |
Opt |
URL for users social media account |
icon4imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon4itemurl |
Opt |
URL for users social media account |
icon5imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon5itemurl |
Opt |
URL for users social media account |
icon6imageurl |
Opt |
URL for social media icon. See appendix B for defaults |
icon6itemurl |
Opt |
URL for users social media account |
template-code |
Opt |
specific to your account. Default mailvu-business |
template-logo-url |
Opt |
URL for the user’s logo. |
template-color1 |
Opt |
user defined field. Used to define color in the template |
template-color2 |
Opt |
user defined field. Used to define color in the template |
template-color3 |
Opt |
user defined field. Used to define color in the template |
template-color4 |
Opt |
user defined field. Used to define color in the template |
template-color5 |
Opt |
user defined field. Used to define color in the template |
template-color6 |
Opt |
user defined field. Used to define color in the template |
Value |
Description |
ok |
Action successful. User was added to the system |
Error 301 |
When certain required parameters are missing |
Error 304 |
When the hash generated by mailvu does not match the hash passed in the parameter. |
Error 324 |
User does not exist in the system. |
When a user is deleted, all the videos stored in the system are also deleted. Videos recorded earlier for this user will not play anymore
Parameter name |
Type |
Description |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
action |
Required |
DELETE_USER: to delete a user from the system. |
user-id |
Required |
MAILVU User Id that was passed back while adding user |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Required |
hexdigest(MD5(action+api-key+user-id+timestamp+partner-secret-key)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
Value |
Description |
ok |
Action successful. User was added to the system |
Error 301 |
When certain required parameters are missing |
Error 304 |
When the hash generated by mailvu does not match the hash passed in the parameter. |
Error 322 |
User does not exist in the system |
Error 323 |
User is already deleted |
Environment |
URL |
Test |
|
Production |
This action will allow users to record a message and when the message is done recording, they click on the “Save Video” and they will be redirected to the page passed in the redirect URL parameter. When the video is done encoding, you get a callback on your callback server with the details of the video.
Parameter name |
Type |
Description |
action |
Required |
RECORD_MSG |
api-key |
Required |
ID of the partner. Given during setup by mailVU. |
request-id |
Required |
REQUEST-ID that is unique for each request. This could be alpha numeric upto 40 chars length. This value will be returned in the callback. If the same request id is sent again, the message will be rejected. |
user-id |
required |
user id of the subscriber requesting this recording |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Required |
hexdigest(MD5(action+api-key+timestamp+user-id+partner-secret-key+request-id)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
redirect-url |
optional |
After the recording is complete When the user clicks on the “Save Video” button, the app will redirect to this page. This could be a dynamic URL specific to this user.
|
This action allows you to record a message and email it out to email addresses passed as parameters.
Parameter name |
Type |
Description |
action |
Required |
RECORD_MSG |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
request-id |
Required |
REQUEST-ID that is unique for each request. This could be alpha numeric upto 20 chars length. This value will be returned in the callback. If the same request id is sent again, the message will be rejected. |
user-id |
required |
user id of the subscriber requesting this recording |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Required |
hexdigest(MD5(action+api-key+timestamp+user-id+partner-secret-key+request-id)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
redirect-url |
optional |
After the recording is complete and a message is displayed, the app will redirect to this page. This could be a dynamic URL specific to this user.
|
from-email |
optional |
From Email address of the sender |
from-name |
optional |
Name of the sender |
to-email |
optional |
email address of the recipient |
cc-email |
optional |
email address to be cc’ed |
email-subject |
optional |
Subject of the message |
email-body |
optional |
Body of the message |
This action allows you to (re) send an already recorded message to some email address passed as parameters
Parameter name |
Type |
Description |
action |
Required |
SEND_MSG |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
request-id |
Required |
REQUEST-ID that is unique for each request. This could be alpha numeric upto 20 chars length. This value will be returned in the callback. If the same request id is sent again, the message will be rejected. |
user-id |
required |
user id of the subscriber requesting this recording |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
msg-id |
Required |
This is the message ID that was passed as parameter when the video was recorded |
hash |
Required |
hexdigest(MD5(action+api-key+timestamp+user-id+partner-secret-key+request-id+msg-id)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
redirect-url |
optional |
After the recording is complete and a message is displayed, the app will redirect to this page. This could be a dynamic URL specific to this user.
|
from-email |
Required |
From Email address of the sender |
from-name |
Required |
Name of the sender |
to-email |
Required |
email address of the recipient |
cc-email |
optional |
email address to be cc’ed |
email-subject |
Required |
Subject of the message |
email-body |
Required |
Body of the message |
Parameter name |
Type |
Description |
action |
Required |
GETMSGHISTORY |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
request-id |
Required |
REQUEST-ID that is unique for each request. |
user-id |
required |
user id of the subscriber requesting this recording |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
msg-id |
Required |
This is the message ID that was passed as parameter when the video was recorded |
hash |
Required |
hexdigest(MD5(action+api-key+timestamp+user-id+partner-secret-key+request-id+msg-id)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
Parameter name |
Type |
Description |
action |
Required |
DOWNLOADORIG (For original uploaded video) DOWNLOADFLV (For flash version) DOWNLOAD_MP4 (For mp4 version) |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
request-id |
Required |
REQUEST-ID that is unique for each request. |
user-id |
required |
user id of the subscriber requesting this recording |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
msg-id |
Required |
This is the message ID that was passed as parameter when the video was recorded |
hash |
Required |
hexdigest(MD5(action+api-key+timestamp+user-id+partner-secret-key+request-id+msg-id)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
When mailvu calls your callback URL it will post the following parameters
Parameter Name |
Description |
request-id |
UNIQUE ID that represent either a user or a request by the user. This is the same ID that was sent during the recording request |
playback-url |
This is the URL you can use to play back the video. This value is URL encoded. |
message-id |
This is the Message ID that can be later used for other api activities. |
thumbnail-url |
URL of the thumbnail image |
user-id |
User Name sent in the request |
width |
Width of the video |
height |
Height of the video |
duration |
Duration of the video in seconds. e.g. 120 for a 2 min long video |
1. Your client (Mobile phone or browser) uploads the video to our server. It
passes a unique request Id that identifies that upload. This request
Id could be any string (GUID).
2. Once the upload is complete the server responds with an OK message to the
mobile phone client. On a desktop, you can supply a redirect URL in
the request so we can redirect the user to that URL. This enables
you to add a custom Thank You page.
3. mailVU then starts converting the video into other formats and creates a thumbnail image from the video
4. After processing is complete, mailVU will call your callback server with
an HTTP post and pass you details about the video. The details
include a play back URL, URL for thumbnail image, video dimensions
and length.
5. You can now store this information in your database and serve it up to
the user.
You can upload video using this URL : http://upload.mailvu.com/app/videoUploadApi.do
Parameter name |
Type |
Description |
accountId |
Required |
API-KEY |
userName |
Required |
UserName of the user uploading the video. This username must have been created using the Create user API above. |
requestId |
Required |
REQUEST-ID that is unique for each request. |
fileData |
Required |
This is the field in which you will send the video file |
widthConstraint |
Optional |
If you want video to be a certain size, you can specify the width constraint. Do not include this field if you want default width |
uploadCompleteUrl |
Optional |
If you want to redirect users to a page after the upload is complete, you include this URL and we will redirect to this URL after the upload is complete. |
callbackUrl |
Optional |
By default the callback is sent to the URL configured at the time of setup. You can optionally include a URL during upload so the callback is sent to this URL instead. |
When mailvu calls your callback URL it will post the following parameters:
Parameter Name |
Description |
request-id |
UNIQUE ID that represent either a user or a request by the user. This is the same ID that was sent during the recording request |
playback-url |
This is the URL you can use to play back the video. This value is URL encoded. |
message-id |
This is the Message ID that can be later used for other api activities. |
thumbnail-url |
URL of the thumbnail image |
user-id |
User Name sent in the request |
width |
Width of the video |
height |
Height of the video |
duration |
Duration of the video in seconds. e.g. 120 for a 2 min long video |
Environment |
URL |
Test |
|
Production |
To Add/Remove Contacts you should call the above URL using HTTP protocol and pass the following parameters as POST or GET variables
Parameter name |
Type |
Description |
api-key |
Req |
ID of the partner. Given during setup by mailVU.
|
action |
Req |
ADD_CONTACT: to add a contact to the system |
user-id |
Req |
A unique ID (Unique for your account) that identifies a user |
timestamp |
Req |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Req |
hexdigest(MD5(action+api-key+user-id+timestamp+partner-secret-key)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
contact-id |
Req |
Primary key of contact which is in your system |
|
opt |
Email address of the contact |
first-name |
opt |
First name of the contact |
middle-name |
opt |
Middle Name of the contact |
last-name |
Opt |
Last name of the contact |
organization |
Opt |
Organization name |
business-phone |
Opt |
Business Phone number |
group1 |
Opt |
Name of Group #1 |
group2 |
Opt |
Name of Group #2 |
group3 |
Opt |
Name of Group #3 |
Value |
Description |
ok |
Action successful. User was added to the system |
Error 301 |
When certain required parameters are missing |
Error 304 |
When the hash generated by mailvu does not match the hash passed in the parameter. |
Error 321 |
User ID already exists in the system |
Parameter name |
Type |
Description |
api-key |
Required |
ID of the partner. Given during setup by mailVU.
|
action |
Required |
DELETE_CONTACT: to delete a user from the system. |
user-id |
Required |
user-id key of the user whose contact is to be deleted |
timestamp |
Required |
Unix Timestamp is number of seconds since January 1, 1970, 00:00:00 GMT. See Appendix A on how to generate this timestamp. If the timestamp is more than 30 mins old, this message will be rejected. |
hash |
Required |
hexdigest(MD5(action+api-key+user-id+timestamp+partner-secret-key)) This is used to validate that the api request is coming from a valid partner and URL is not being reused/changed. The partner-secret-key is assigned to the partner at the time of setup. It is never sent in plaintext.
|
contact-id |
Required |
contact-id key in your system |
Value |
Description |
ok |
Action successful. User was added to the system |
Error 301 |
When certain required parameters are missing |
Error 304 |
When the hash generated by mailvu does not match the hash passed in the parameter. |
Error 322 |
User does not exist in the system |
Error 323 |
User is already deleted |
In order to show the video passed as a link to you.
playback-url, height and width were passed to you as parameters in the callback URL
<iframe src=”{playback-url}” frameborder=”no” height=”{height}” width=”{width}”> </iframe>
You can send an email to a user by embedding following HTML code in the email
<a href=”${playback-url}”><img src=”${thumbnail-url}” border=”0”/></a>
Java:
private long getTimeStamp() {
Date now=new Date();
return now.getTime()/1000;
}
PHP: time();
ASP:
function getunixtimestamp()
currentdatetime = now()
getunixtimestamp = DateDiff("s", "01/01/1970 00:00:00", currentdatetime)
end function
Private
and Confidential - (C) A2Stream Inc.