FV API Documentation

Description

This API helps to Opt-In and Opt-Out SMS Alerts for an Account

Request Parameters

Y = Required, Y* = Conditional, X = Required When Block Present and N = Optional

APIAccessToken*

-[string(256)]--Issued by FirstView web services authorization call. Auth Token is valid for 24 hours and is required to obtain a new token prior to the expiration. Has to be send in the "Authorization" Header when making the requests

Property	Description	Required	Type
CARD_NUMBER	16-digit Card Number Example: 1234123412341234	Y*	string Length = 16 digits
ADMIN_NO	Unique Embossing Number Associated to Card Example: 123456	Y*	string Length >= 6 digits
ACCOUNT_NO	16-digit Account Number Example: 1234123412341234	Y*	string Length = 16 digits
SMS_STATUS_SET	1: Opt-In 2: Opt-Out	Y	string Length = 1
MOBILE_NUMBER	Card Holders Mobile Number to Receive SMS Alerts Example: 1234567890	X	string Length >= 3
SMS_ADDRESS	Mobile Carrier SMS Specific GateWay Address Possible Values Are: (SMS Address Value: Mobile Carrier) comcastpcs.textmsg.com : Comcast PCS email.uscc.net : US Cellular message.alltel.com : AllTel messaging.nextel.com : Nextel messaging.sprintpcs.com: Sprint mymetropcs.com : Metro PCS pagemci.com : MCI qwestmp.com : Qwest tmomail.net : T-Mobile tms.suncom.com : SunCom txt.att.net : AT&T vmobl.com : Virgin Mobile vtext.com : Verizon	X	string Length = 100
ENROLL_ALL_SMS	Yes: Will enroll the customer for all available Messages for its Product (work as SMS Setup). No: Will only enroll for SMS Setup (will work as SMS Enrollment)	Y	string Length = 3
ANI	ANI Number, Used for reporting and error tracking	N	string Length <= 30
DNIS	DNIS Number, Used for reporting and error tracking	N	string Length <= 30

Note:

(Y*):CARD_NUMBER OR ACCOUNT_NO OR ADMIN_NO must be present in Request

(X): Required for SMS Enrollemnt

Return Values

MessageResponse

Property	Description	Type
ERRMSG	Error message	string Length <= 30
ERR_NUMBER	Error number for the returns message	Numeric Length <= 19
ERROR_FOUND	If any error found, then “Yes” else “No”	string Length <= 3

REST

Method: POST

Urls:

Production:	https://api.fvfn.net/fvfnunvwebapi/core/SMSEnrollment
SandBox:	https://api.firstviewcorp.com/fvfnunvwebapi/core/SMSEnrollment

JSON Request:

{
  "ACCOUNT_NO": null,
  "CARD_NUMBER": null,
  "ADMIN_NO": null,
  "SMS_STATUS_SET": null,
  "MOBILE_NUMBER": null,
  "SMS_ADDRESS": null,
  "ENROLL_ALL_SMS": null,
  "ANI": null,
  "DNIS": null
}

Response:

{
  "ERROR_FOUND": null,
  "ERR_NUMBER": null,
  "ERRMSG": null
}

SMSEnrollment API