Genesys Mobile Services API Reference

'34=#4=2080<,>0/1<97,?>39<4>,>4@0986480.98>08>,8/

4=:<9@4/0/19<[email protected]986C'34=#.,889>-0?=0/

19<602,6:?<:9=0=9<,?>39<4>,>4@0?8/0<=>,8/48291A3,>

4=,8/4=89>=?::9<>0/,6A,C=?=0>30986480.98>08>'9

.9:C.9/0=,7:60=,6A,C=?=0>30986480.98>08>

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#

%010<08.0



Contents

D  ,66-,.5#?=3!9>4E.,>498=19<8/<94/

D  #<9.0/?<0

D  4,692=%&'

D  #?=3!9>4E.,>498=

080=C= 9-460&0<@4.0=#%010<08.0 

Callback Push Notications for Android

080=C= 9-460&0<@4.0= &07:69C=@,<49?=70.3,84=7=>9,.340@0,=C8.3<989?=70==,2482

:?=389>4E.,>498=9<8/<94//[email protected]=4>4=,.97-48,>49891 ,8/970>450A4=04"&/[email protected]=

07:69C#!=,8/970>'30=.9:091>34=,<>4.604=6474>0/>939A:?=389>4E.,>498=,<03,8/60/48

8/<94//[email protected]=:,<>4.?6,<6C19<>30,66-,.5,::64.,>498

!9>09<4"&/[email protected]==00 ,66-,.5#?=3!9>4E.,>498=19<4"&

Procedure

7:60708>482,8 .6408> 4=A066/9.?708>0/-C992606>0<8,>06CC9?.,8,6=9<010<>9>30

080=C= 9-460&0<@4.0=8/<94/&,7:60 19<,080=C= 47:60708>,>498

#?=389>4E.,>498=.,8-0/4@4/0/48>9>A9/4=>48.>:,<>=

 3,>47:60708>=:?=389>4E.,>498=9@0<970>

 ,66-,.547:60708>0/9@0< 

9<3,>,,C0?B6408>4=.<0,>0/>964=>08>9,66:?=389>4E.,>498=<06,>0/>93,>'30/01,?6>

.3,880619<3,>4= /_genesys'3019<7,>913,>:?=389>4E.,>498=.,8-0=00848>30 3,>970>

=0.>498

9<,66-,.5:?=389>4E.,>498=<010<>9>30 080=C= 9-460&0<@4.0=8/<94/&,7:60 19<<010<08.0

#<9.0==48291 89>4E.,>498=4=,>3<00=>0::<9.0/?<0

 "->,48&0<@4.0,8/.>4984/08>4E0<1<97 8>08>

 ==?0''##"&'>9 &A4>3=:0.4E0/,.>498>99->,48,.>498/,>,,=&"!

 B0.?>0,.>498?=482/,>,:<9@4/0/-C &

'30/,>,.98>,480/A4>348>30 8>08>4==><?.>?<0/,=19669A=

Intent intent;

Bundle extras = intent.getExtras();

String message = extras.getString("message");

System.out.println(message);

---------------------------------------------

Result:

{

"_id":"$(_id)",

"_action":"$(_action)",

}

8>30.,=091>30080=C==,7:60.6408>>30 GenesysCloudMessageReceiver <0:,.5,20=>30

8>08>48>9,8,::64.,>498=:0.4E.8>08>

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#%010<08.0 

Intent newIntent = new Intent(context, GenesysSampleActivity.class);

newIntent.setAction(Globals.ACTION_GENESYS_CLOUD_MESSAGE);

newIntent.putExtra(Globals.EXTRA_MESSAGE, extras.getString("message"));

newIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);

context.startActivity(newIntent);

'34=48>08>4=>3083,8/60/-C>30 GenesysSampleActivity (handleIntent() 

interpretCloudMessage()) A30<0>3008.,:=?6,>0//,>,4=?=0/>919<7,8''##"&'A4>3>30

19669A482(%

$(ServerURL)$(URLPath)$(_id)/$(_action)

for example,

http://135.34.145.123:8080/genesys/1/service/3SQI3S31693JL9

L3R0O5O6T4OC000U73/get-dialog-start-chat

Identier Description Example Values

&0<@0<(%

(%>9080=C= 9-460&0<@4.0=

39=>

3>>:

(%#,>3 #,>3>9&0<@4.0=# 2080=C==0<@4.0

+4/  &4==?0/&0<@4.0 &$&%""'"(

+,.>498 ,66-,.5,.>498>9:0<19<7

20>/4,692?=0<.98E<7,>498

:<9@4/0+.9/0><?0

20>/4,692?=0<.98E<7,>498

:<9@4/0+.9/01,6=0

20>/4,692=>,<>.3,>

.9880.>48-9?8/

.9880.>9?>-9?8/

A,4>19<,208>

'30<0=:98=091>30''##"&'<0;?0=>.98>,48=&"!A34.3/0=.<4-0=,8,.>498>9:0<19<7,8/9<

(060708>=>9/4=:6,C48>30.6408>,::64.,>498,.391>30=0<0;?0=>=4=<010<<0/>9,=4,692=

Dialogs (REST)

'3019669A4820B,7:60=,<0&"!=><?.>?<0=<0>?<80/-C>30 &,66-,.5=0<@4.0>9>30.6408>

,::64.,>498'30.98>08>=91>30&"!<0=:98=0/0:08/98>30,66-,.5,.>498:0<19<70/,=

/0=.<4-0/48>30 #<9.0/?<0=0.>498

%010<>9>30 080=C= 9-460&0<@4.0=8/<94/&,7:60 19<0B,7:60=9139A>30=0&"!<0=:98=0=.,8

-048>0<:<0>0/,=,.>498=19<0B,7:60,66,208>4=:6,C708?4=:6,C/4,692,8/9<(060708>=

19<0B,7:60 Conrmation dialogs or Menu items

20>/4,692?=0<.98E<7,>498:<9@4/0+.9/0><?0

{

"_dialog_id":"0",

"_label":"Agent is available right now",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/not-used",

"_method":"POST",

"_action":"DisplayMenu",

"_expires": "$(Date)",

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#%010<08.0 

"_resource_url":

"$(ExtURLBase)/1/service/$(ServiceID)/get-dialog-user-confirmation",

"_content":[

{

"_group_name":"Are you ready?",

"_group_content":[

{

"_dialog_id":"1",

"_label":"Yes, I'm ready to talk",

"_action":"MenuItem",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/connect",

"_method":"POST",

"_id_to_jump_before":"exit://",

"_confirmation_dialog":{

"_text":

"You will hear tones immediately after call is connected. This is normal.",

"_dialog_type":"Notification",

"_dismiss_timeout": 2

}

},{

"_dialog_id":"2",

"_label":"No, try again in 5 minutes",

"_action":"MenuItem",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/snooze",

"_method":"POST",

"_id_to_jump_before":"exit://"

},{

"_dialog_id":"3",

"_label":"Cancel, my problem has been solved",

"_action":"MenuItem",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/cancel",

"_method":"POST",

"_id_to_jump_before":"exit://"

}

]

}

]

}

20>/4,692?=0<.98E<7,>498:<9@4/0+.9/01,6=0

{

"_dialog_id":"0",

"_label":"Agent is available right now",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/not-used",

"_method":"POST",

"_action":"DisplayMenu",

"_expires": "$(Date)",

"_resource_url":

"$(ExtURLBase)/1/service/$(ServiceID)/get-dialog-user-confirmation",

"_content":[

{

"_group_name":"Are you ready?",

"_group_content":[

{

"_dialog_id":"1",

"_label":"Yes, I'm ready to talk",

"_action":"MenuItem",

"_user_action_url":

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#%010<08.0 

"$(ExtURLBase)/1/service/$(ServiceID)/connect",

"_method":"POST",

"_id_to_jump_before":"exit://",

},{

"_dialog_id":"2",

"_label":"No, try again in 5 minutes",

"_action":"MenuItem",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/snooze",

"_method":"POST",

"_id_to_jump_before":"exit://"

},{

"_dialog_id":"3",

"_label":"Cancel, my problem has been solved",

"_action":"MenuItem",

"_user_action_url":

"$(ExtURLBase)/1/service/$(ServiceID)/cancel",

"_method":"POST",

"_id_to_jump_before":"exit://"

}

]

}

]

}

20>/4,692=>,<>.3,>

{

"_dialog_id": "1",

"_action":"StartChat",

"_label":"Start Chat",

"_start_chat_url":

"$(ExtURLBase)/1/service/$(ServiceID)/ixn/chat",

"_comet_url":"$(CometURL)",

"_user_header":"$(GMSUser)",

"_id_to_jump_before":"exit://",

"_chat_parameters":{

"subject":"None"

"_id":"$(ServiceID)"

}

.9880.>48-9?8/

{

"_dialog_id":"0",

"_label":"Connecting ...",

"_action":"DialNumber",

"_tel_url":"n/a",

"_access_code":"n/a",

"_id":"$(ServiceID)"

}

.9880.>9?>-9?8/

{

"_dialog_id":"0",

"_action":"ConfirmationDialog",

"_text":"You will receive the call shortly",

"_ok_title":"Ok",

"_id":"$(ServiceID)"

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#%010<08.0 

}

A,4>19<,208>

{

"_dialog_id":"0",

"_action":"ConfirmationDialog",

"_text":"We will notify you when agent is available",

"_ok_title":"Ok",

"_id":"$(ServiceID)"

}

Push Notications

3,>970>

0==,20%0.04:>

{

"data":{

"message":{

"startedAt":"2014-05-02T16:27:38Z",

"chatIxnState":"TRANSCRIPT",

"chatSessionId":"000FRa9NYM9A001K",

"transcriptToShow":[["Message.Text","Stan","Hello.","8","CLIENT"]],

"transcriptPosition":"2",

"chatServiceMessage":"Chat service is available"

"id":"b2e607a0d21611e3000010932938a0ff",

"tag":"service.chat.refresh.3SQIS3S1693JL9L3R00506T40C000UL4"

"channel":"/_genesys"

}

#,<>C9480/01>

{

"data":{

"message":{

"startedAt":"2014-05-02T16:27:38Z",

"chatIxnState":"TRANSCRIPT",

"chatSessionId":"000FRa9NYM9A001K",

"transcriptToShow":[["Notice.Joined","Kristi Sippola",

"has joined the session","17","AGENT"]],

"transcriptPosition":"3",

"chatServiceMessage":"Chat service is available",

"id":"b7dd6460d21611e3000010932938a0ff",

"tag":"service.chat.refresh.3SQIS3S1693JL9L3R00506T40C000UL4"

"channel":"/_genesys"

}

'C:482&>,<>0/&>9::0/

{

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#%010<08.0 

"data":{

"message":{

"startedAt":"2014-05-02T16:27:38Z",

"chatIxnState":"TRANSCRIPT",

"chatSessionId":"000FRa9NYM9A001K",

"transcriptToShow":[["Notice.TypingStarted",

"Kristi Sippola","is typing","20","AGENT"]],

"transcriptPosition":"4",

"chatServiceMessage":"Chat service is available",

"id":"b91bd7d0d21611e3000010932938a0ff",

"tag":"service.chat.refresh.3SQIS3S1693JL9L3R00506T40C000UL4"

"channel":"/_genesys"

}

!9>0=

Identier Description Values

'<,8=.<4:>'C:0

'C:0910@08>>9/4=:6,C48>30

.3,>692

0==,20'0B>

!9>4.0'C:482&>,<>0/

!9>4.0'C:482&>9::0/

!9>4.09480/

!9>4.001>

'470=>,7: (''47019<7,> )))) ' &&*

'<,8=.<4:>#9=4>498 480!?7-0< &97048>020<

3,>B8&>,>0 &>,>091.3,>48>0<,.>498

'%!&%#'

&"!!'

,66-,.5#?=3!9>4E.,>498=19<8/<94/

080=C= 9-460&0<@4.0=#%010<08.0 