CISCO Enterprise Chat and Email Developer's Guide to Web სერვისის მომხმარებლის სახელმძღვანელო
Enterprise Chat and Email Developer's Guide to Web სერვისის API ჩეთისთვის, გამოშვება 12.6(1)
ერთიანი საკონტაქტო ცენტრის საწარმოსთვის და შეფუთული საკონტაქტო ცენტრის საწარმოსთვის
პირველად გამოქვეყნდა: 2021 წლის მაისი
ბოლო განახლება: მარტი, 2023 წელი
ამერიკის შტაბ-ბინა
Cisco Systems, Inc.
170 დასავლეთ ტასმანის წამყვანი
სან ხოსე, CA 95134-1706
აშშ
https://www.cisco.com
ტელ: 408 526-4000 წწ
800 553-NETS (6387)
ფაქსი: 408 527-0883 წწ
ამ სახელმძღვანელოში მოცემული სპეციფიკაციები და ინფორმაცია პროდუქტებთან დაკავშირებით ექვემდებარება ცვლილებას შეტყობინების გარეშე. ყველა განცხადება, ინფორმაცია და რეკომენდაცია ამ სახელმძღვანელოში მიჩნეულია, რომ ზუსტია, მაგრამ წარმოდგენილია რაიმე სახის, გამოხატული ან ნაგულისხმევი გარანტიის გარეშე. მომხმარებლებმა უნდა აიღონ სრული პასუხისმგებლობა ნებისმიერი პროდუქტის გამოყენებაზე.
პროგრამული უზრუნველყოფის ლიცენზია და შეზღუდული გარანტია თანმხლები პროდუქტისთვის მითითებულია საინფორმაციო პაკეტში, რომელიც გაიგზავნება პროდუქტთან ერთად და ჩართულია აქ ამ მითითებით. თუ ვერ ახერხებთ პროგრამული უზრუნველყოფის ლიცენზიის ან შეზღუდული გარანტიის პოვნას, დაუკავშირდით თქვენს CISCO-ს წარმომადგენელს ასლისთვის.
TCP სათაურის შეკუმშვის Cisco იმპლემენტაცია არის პროგრამის ადაპტაცია, რომელიც შემუშავებულია კალიფორნიის უნივერსიტეტის, ბერკლის (UCB) მიერ, როგორც UCB-ის UNIX ოპერაციული სისტემის საჯარო დომენის ვერსიის ნაწილი. ყველა უფლება დაცულია. Copyright © 1981, კალიფორნიის უნივერსიტეტის რეგენტები.
წინამდებარე ნებისმიერი სხვა გარანტიის მიუხედავად, ყველა დოკუმენტი FILEამ მომწოდებლების S და პროგრამული უზრუნველყოფა მოწოდებულია „როგორც არის“ ყველა ხარვეზით. CISCO და ზემოთ დასახელებული მომწოდებლები უარს აცხადებენ ყველა გარანტიაზე, გამოხატულ ან ნაგულისხმევი, მათ შორის, შეზღუდვის გარეშე, სავაჭრო ობიექტებზე, კონკრეტული მიზნისთვის ვარგისიანობაზე და არადარღვევისთვის. გამოყენება, ან ვაჭრობის პრაქტიკა.
არავითარ შემთხვევაში CISCO ან მისი მომწოდებლები არ აგებენ პასუხისმგებლობას რაიმე არაპირდაპირი, განსაკუთრებული, თანმდევი ან შემთხვევითი ზიანისთვის, მათ შორის, შეზღუდვის გარეშე, დაკარგული მოგება ან ზარალი ან ზარალი. ამ სახელმძღვანელოს გამოსაყენებლად, მაშინაც კი, თუ CISCO ან მისი მომწოდებლები მიიღეს რეკომენდაცია ასეთი ზიანის შესაძლებლობის შესახებ.
ნებისმიერი ინტერნეტ პროტოკოლის (IP) მისამართები და ტელეფონის ნომრები, რომლებიც გამოიყენება ამ დოკუმენტში, არ არის გამიზნული რეალურ მისამართებად და ტელეფონის ნომრებად. ნებისმიერი ყოფილიamples, ბრძანების ჩვენების გამომავალი, ქსელის ტოპოლოგიის დიაგრამები და დოკუმენტში შეტანილი სხვა ფიგურები ნაჩვენებია მხოლოდ საილუსტრაციო მიზნებისთვის. რეალური IP მისამართების ან ტელეფონის ნომრების ნებისმიერი გამოყენება საილუსტრაციო შინაარსში არის უნებლიე და შემთხვევითი.
Cisco და Cisco-ს ლოგო არის Cisco-ს ან/და მისი შვილობილი კომპანიების სავაჭრო ნიშნები ან რეგისტრირებული სავაჭრო ნიშნები აშშ-სა და სხვა ქვეყნებში. რომ view Cisco სავაჭრო ნიშნების სია, გადადით https://www.cisco.com/go/trademarks. აღნიშნული მესამე მხარის სავაჭრო ნიშნები არის მათი შესაბამისი მფლობელების საკუთრება. სიტყვის პარტნიორის გამოყენება არ გულისხმობს Cisco-სა და სხვა კომპანიას შორის პარტნიორულ ურთიერთობას. (1110R)
Enterprise Chat and Email Developer's Guide to Web სერვისის API ჩეთისთვის: ერთიანი საკონტაქტო ცენტრის საწარმოსთვის და შეფუთული საკონტაქტო ცენტრის საწარმოსთვის. 8 წლის 2019 იანვარი © 2016-2021 Cisco Systems, Inc. ყველა უფლება დაცულია.
კეთილი იყოს თქვენი მობრძანება Enterprise Chat and Email (ECE) ფუნქციაში, რომელიც უზრუნველყოფს მრავალარხიანი ურთიერთქმედების პროგრამულ უზრუნველყოფას, რომელსაც იყენებენ ბიზნესები მთელ მსოფლიოში, როგორც ძირითადი კომპონენტი Unified Contact Center Enterprise პროდუქტის ხაზისთვის. ECE გთავაზობთ ინდუსტრიის საუკეთესო აპლიკაციების ერთიან კომპლექტს ჩეთისა და ელ.ფოსტის ურთიერთქმედების მართვისთვის, რათა შერეული აგენტი ჩართოს web ჩატი, ელ.ფოსტა და ხმოვანი ურთიერთქმედება.
ამ სახელმძღვანელოს შესახებ
დეველოპერების გზამკვლევი Web სერვისის API ჩეთისთვის აღწერს, თუ როგორ შეუძლიათ კლიენტებს ჩეთის გამოყენება Web სერვისების API-ები, რათა აჩვენონ ჩატის ბმული მათზე web საიტები, რომლებიც დაფუძნებულია რიგის სიღრმეზე და აგენტების ხელმისაწვდომობაზე ახალი ჩეთების დასამუშავებლად.
Cisco-ს ყველა დოკუმენტაციის უახლესი ვერსიები შეგიძლიათ იხილოთ ონლაინ მისამართზე https://www.cisco.com
საგანი |
ბმული |
სრული დოკუმენტაცია Enterprise Chat-ისა და Email-ისთვის, როგორც Cisco Unified Contact Center Enterprise (UCCE) და Cisco Packaged Contact Center Enterprise (PCCE) | https://www.cisco.com/c/en/us/support/customer-collaboration/cisco-enterprise-chat- email/tsd-products-support-series-home.html |
კომუნიკაციები, სერვისები და დამატებითი ინფორმაცია
- Cisco-სგან დროული, შესაბამისი ინფორმაციის მისაღებად, დარეგისტრირდით Cisco Pro-შიfile მენეჯერი.
- იმისთვის, რომ მიიღოთ ბიზნესზე გავლენა, რომელსაც ეძებთ მნიშვნელოვანი ტექნოლოგიებით, ეწვიეთ Cisco Services-ს.
- სერვისის მოთხოვნის გასაგზავნად ეწვიეთ Cisco მხარდაჭერას.
- უსაფრთხო, დადასტურებული საწარმოს კლასის აპების, პროდუქტების, გადაწყვეტილებებისა და სერვისების აღმოსაჩენად და დასათვალიერებლად, ეწვიეთ Cisco-ს ბაზარი.
- ზოგადი ქსელის, ტრენინგის და სერტიფიცირების ტიტულების მისაღებად, ეწვიეთ Cisco Press-ს.
- კონკრეტული პროდუქტის ან პროდუქტის ოჯახის საგარანტიო ინფორმაციის საპოვნელად, წვდომა Cisco გარანტიის Finder
Cisco Bug Search Tool
Cisco Bug Search Tool (BST) არის ა webდაფუძნებული ინსტრუმენტი, რომელიც მოქმედებს როგორც კარიბჭე Cisco-ს შეცდომების თვალთვალის სისტემისკენ, რომელიც ინახავს დეფექტებისა და დაუცველობის ყოვლისმომცველ ჩამონათვალს Cisco-ს პროდუქტებსა და პროგრამულ უზრუნველყოფაში. BST გაწვდით დეტალურ ინფორმაციას დეფექტების შესახებ თქვენი პროდუქტებისა და პროგრამული უზრუნველყოფის შესახებ
საველე გაფრთხილებები და საველე შეტყობინებები
Cisco-ს პროდუქტები შეიძლება შეიცვალოს ან ძირითადი პროცესები მნიშვნელოვანი იყოს. ეს გამოცხადებულია Cisco Field Alerts და Cisco Field Notices-ის გამოყენებით. თქვენ შეგიძლიათ დარეგისტრირდეთ, რომ მიიღოთ საველე გაფრთხილებები და საველე შეტყობინებები პროდუქტის გაფრთხილების ხელსაწყოს მეშვეობით Cisco.com-ზე. ეს ინსტრუმენტი საშუალებას გაძლევთ შექმნათ პროფესიონალიfile მიიღოს განცხადებები ყველა საინტერესო პროდუქტის შერჩევით.
შედით სისტემაში www.cisco.com და შემდეგ შედით ხელსაწყოზე https://www.cisco.com/cisco/support/notifications.html
დოკუმენტაციის კავშირი
ჩვენ ვაფასებთ თქვენს კომენტარებს.
დოკუმენტის კონვენციები
ეს სახელმძღვანელო იყენებს შემდეგ ტიპოგრაფიულ კონვენციებს.
კონვენცია | მიუთითებს |
დახრილი | ხაზგასმა.ან გამოქვეყნებული დოკუმენტის სათაური. |
თამამი | ელემენტის ეტიკეტები მომხმარებლის ინტერფეისზე, როგორიცაა ღილაკები, ყუთები და სიები. ან ტექსტი, რომელიც უნდა იყოს აკრეფილი მომხმარებლის მიერ. |
მონოკოსმოსი | სახელი ა file ან საქაღალდე, მონაცემთა ბაზის ცხრილის სვეტი ან მნიშვნელობა, ან ბრძანება. |
ცვლადი | მომხმარებლის სპეციფიკური ტექსტი; განსხვავდება ერთი მომხმარებლისგან ან ინსტალაციის მიხედვით. |
შესავალი
Enterprise Chat და Email კლიენტებს შეუძლიათ გამოიყენონ ჩატი Web სერვისების API-ები, რათა აჩვენონ ჩატის ბმული მათზე web საიტები, რომლებიც დაფუძნებულია აგენტების ხელმისაწვდომობაზე ახალი ჩეთების დასამუშავებლად. API შეიძლება გამოყენებულ იქნას შემდეგი მიზნებისთვის:
- ჩატი ღილაკის ჩართვის ან გამორთვისთვის web საიტები, რომლებიც დამოკიდებულია ხელმისაწვდომი აგენტებზე.
- იმ დროის გასაგებად, რომ მომხმარებელს შეიძლება დასჭირდეს ლოდინი, სანამ აგენტი ხელმისაწვდომი იქნება ჩეთში.
- კლიენტის პოზიციის მოსაძებნად რიგში, რათა შეფასდეს, რამდენი ხანი შეიძლება მოუწიოს მომხმარებელს ლოდინი, სანამ აგენტი ხელმისაწვდომი იქნება ჩეთისთვის.
- დაწერეთ ახალი მორგებული გამოკითხვები ჩეთის სესიებისთვის დამატებითი მონაცემების მისაღებად.
API დანერგვა მიჰყვება REST-ზე დაფუძნებული API-ების სტანდარტებს და უზრუნველყოფს ანონიმურ წვდომას. API აბრუნებს მონაცემებს XML ფორმატში.
მხარდაჭერილი ვერსიები
- ECE 12.6 (1)
- ECE 12.5 (1)
სქემის განმარტებები
გამოყენებული სქემის განმარტებები web სერვისები ხელმისაწვდომია XSD სახით files განაწილებაში. თქვენ შეგიძლიათ გამოიყენოთ PackI ინსტრუმენტი სქემის განმარტებების ამოსაღებად. ისინი განთავსებულია ელექტრონულ სერვისში. ყური file ლოკაციაზე
lib/int/egpl_application_server.jar/com/egain/live/framework/bosh/xsd.
ჩეთის ოფციის ჩვენება აგენტის ხელმისაწვდომობის მიხედვით
შეამოწმეთ არის თუ არა რაიმე ხელმისაწვდომი აგენტი (განსაზღვრულია, როგორც ჩეთის ხელმისაწვდომობის ჩამრთველი, რომელიც არჩეულია Agent Console-ში), რომლებსაც შეუძლიათ მართონ ჩეთები, რომლებიც იწყება კონკრეტული შესვლის წერტილიდან. გამოიყენეთ ეს API, რათა გადაწყვიტოთ ჩეთის ბმულის ჩვენება ან დამალვა webსაიტი აგენტის ხელმისაწვდომობაზე დაყრდნობით.
მოთხოვნა
მოთხოვნას აგენტის ხელმისაწვდომობის შესამოწმებლად აქვს შემდეგი ფორმა:
მეთოდი | URL |
მიიღეთ | /egain/chat/entrypoint/agentAvailability/id |
URL პარამეტრები
სახელი | აღწერა | ტიპი | საჭირო | ნაგულისხმევი მნიშვნელობა არჩევითი პარამეტრები |
ID | შესვლის წერტილის ID, რომლისთვისაც გსურთ შეამოწმოთ აგენტის ხელმისაწვდომობა. | გრძელი | დიახ |
სათაურების მოთხოვნა
არ გამოიყენება.
მოთხოვნის ორგანო
არცერთი
XSD FOR RQUEST BODY
არ გამოიყენება.
SAMPმოითხოვეთ XML
არ გამოიყენება.
პასუხი
პასუხი მოიცავს HTTP სტატუსის კოდს და პასუხის ორგანოს.
სტატუსის კოდები
წარმატების კოდები:
200: აგენტის ხელმისაწვდომობის სტატუსი დაბრუნდა. ჭეშმარიტი პასუხი ნიშნავს, რომ აგენტი ხელმისაწვდომია. ცრუ პასუხი ნიშნავს, რომ აგენტი არ არის ხელმისაწვდომი.
შეცდომის კოდები:
- 500: აგენტის ხელმისაწვდომობის ინფორმაციის მოძიება შეუძლებელია.
პასუხის სათაურები
არ გამოიყენება.
საპასუხო ორგანო
HTTP/1.1 200 OK
<agentAvailability available=”true” xmlns: ns2=” http://bindings.egain.com/chat ” xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=” jabber:client” xmlns:ns5=”http://jabber.org/protocol/httpbind "/>
XSD პასუხის ორგანო
XML სქემა განსაზღვრულია agentAvailability კვანძში eGainBosh.xsd-ში. file.
ჩეთის ოფციის ჩვენება აგენტის ტევადობის მიხედვით ჩეთებისთვის
იღებს ყველა აგენტის შესაძლებლობას იმუშაონ ჩეთის ახალ აქტივობებზე მოცემულ შესვლის წერტილში შედგენილ რიგში.
ეს API აბრუნებს განსხვავებას მაქსიმალურ დატვირთვას შორის, რომელსაც შეუძლია მიიღოს ყველა აგენტი და ყველა აგენტის მიმდინარე დატვირთვას შორის შესვლის წერტილის რიგში. გამოიყენეთ ეს API, რათა გადაწყვიტოთ აჩვენოთ ჩატის ღილაკი ან შესთავაზოთ ახალი ჩეთები კლიენტებს მხოლოდ მაშინ, როდესაც ხელმისაწვდომია აგენტები მეტი სამუშაოს მისაღებად.
მოთხოვნა
მოთხოვნას აგენტის შესაძლებლობების შესამოწმებლად აქვს შემდეგი ფორმა:
მეთოდი | URL |
მიიღეთ | /egain/chat/entrypoint/capacity/id |
URL პარამეტრები
სახელი | აღწერა | ტიპი | საჭირო | ნაგულისხმევი მნიშვნელობა არჩევითი პარამეტრები |
ID | შესვლის წერტილის ID, რომლისთვისაც გსურთ შეამოწმოთ აგენტის მოცულობა. | გრძელი | დიახ |
სათაურების მოთხოვნა
არ გამოიყენება.
მოთხოვნის ორგანო
არ გამოიყენება.
XSD FOR RQUEST BODY
არ გამოიყენება.
SAMPმოითხოვეთ XML
არ გამოიყენება.
პასუხი
პასუხი მოიცავს HTTP სტატუსის კოდს და პასუხის ორგანოს.
სტატუსის კოდები
წარმატების კოდები:
- 200: აგენტების დარჩენილი ტევადობა შესვლის პუნქტისთვის ბრუნდება. დადებითი რიცხვი ასახავს დარჩენილ სიმძლავრეს. ნულოვანი ნიშნავს ან სისტემაში არ არის ხელმისაწვდომი აგენტები, ან ყველა აგენტი მუშაობს მაქსიმალური დატვირთვით.
შეცდომის კოდები:
- 500: ინფორმაციის მოძიება შეუძლებელია.
პასუხის სათაურები
არ გამოიყენება.
საპასუხო ორგანო
გამომავალი გენერირებულია XML ფორმატში.
HTTP/1.1 200 OK
<availableSlots xmlns: ns1.0=”http://bindings.egain.com/chat “
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:client”
xmlns:ns5=” http://jabber.org/protocol/httpbind "> 2
XSD პასუხის ორგანო
XML სქემა განსაზღვრულია availableSlots კვანძში eGainBosh.xsd-ში. file.
ჩეთის ოფციის ჩვენება რიგის სიღრმისა და ლოდინის დროის მიხედვით
მიიღეთ დეტალები დავალების რიგში მყოფი ჩეთების რაოდენობისა და რიგში ლოდინის სავარაუდო დროის შესახებ.
გამოიყენეთ ეს API, რათა გადაწყვიტოთ ჩეთის ბმულის ჩვენება ან დამალვა webსაიტი დაფუძნებულია ლოდინის დროზე და რიგში მყოფი ჩეთების რაოდენობაზე.
დაბრუნებული WaitTime მნიშვნელობა იზომება წამებში. ეს მნიშვნელობა ეფუძნება აგენტისთვის მინიჭებული ბოლო 20 აქტივობის საშუალო დაყოვნების დროს და როდესაც აგენტი დააწკაპუნებს აქტივობაზე მასზე მუშაობის დასაწყებად. ეს ითვალისწინებს რიგში ლოდინის დროს გატარებულ დროს, ასევე აგენტის შემოსულებში გატარებულ დროს, სანამ აგენტი დაუკავშირდება კლიენტს ჩეთის საშუალებით.
მოთხოვნა
რიგში ლოდინის დროისა და ჩეთის რაოდენობის შესამოწმებლად მოთხოვნას აქვს შემდეგი ფორმა:
მეთოდი | URL |
მიიღეთ | /egain/chat/entrypoint/liveSessionStatus/id |
URL პარამეტრები
სახელი |
აღწერა | ტიპი | საჭირო | ნაგულისხმევი მნიშვნელობა არჩევითი პარამეტრები |
ID | შესვლის წერტილის ID, რომლისთვისაც გსურთ შეამოწმოთ რიგის სიღრმე და ლოდინის დრო. | გრძელი | დიახ |
სათაურების მოთხოვნა
არ გამოიყენება.
მოთხოვნის ორგანო
არ გამოიყენება.
XSD FOR RQUEST BODY
არ გამოიყენება.
SAMPმოითხოვეთ XML
არ გამოიყენება.
პასუხი
პასუხი მოიცავს HTTP სტატუსის კოდს და პასუხის ორგანოს.
სტატუსის კოდები
წარმატების კოდები:
200: რიგის სიღრმე და ლოდინის დრო ბრუნდება.
შეცდომის კოდები:
- 500: რიგის სიღრმისა და ლოდინის დროის აღდგენა შეუძლებელია.
პასუხის სათაურები
არ გამოიყენება.
საპასუხო ორგანო
გამომავალი გენერირებულია XML ფორმატში.
HTTP/1.1 200 OK
<sessionStatus xmlns: ns2=”http://bindings.egain.com/chat“
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:client” xmlns:ns5=”http://jabber.org/protocol/httpbind">
<ns2:waitTime>3.0</ns2:waitTime> <ns2:queueDepth>1</ns2:queueDepth>
XSD პასუხის ორგანო
XML სქემა განსაზღვრულია sessionStatus კვანძში eGainBosh.xsd-ში. file.
ჩეთის ოფციის ჩვენება რიგის სიღრმეზე და აგენტის ხელმისაწვდომობაზე
ამოწმებს ჩეთის შესვლის წერტილის უფლებამოსილებას ახალი ჩეთის აქტივობების დასამუშავებლად შემდეგი პირობების საფუძველზე:
- თუ არსებობს რაიმე აგენტი, რომელიც მუშაობს ახალ ჩეთის აქტივობებზე.
- თუ ამ შესვლის წერტილთან ასოცირებულმა რიგმა მიაღწია კონფიგურირებულ მაქსიმალურ სიღრმეს, ანუ რიგის მიერ დამუშავებული ჩატების საერთო რაოდენობა უდრის ჩატების მაქსიმალურ რაოდენობას, რომლის დამუშავება რიგს შეუძლია დროის მოცემულ მომენტში.
გამოიყენეთ ეს API, რათა გადაწყვიტოთ ჩეთის ბმულის ჩვენება ან დამალვა webსაიტი აგენტის ხელმისაწვდომობაზე დაფუძნებული და შეუძლია თუ არა მოცემულ შესვლის წერტილთან დაკავშირებულ რიგს მეტი ჩატის მიღება.
მოთხოვნა
ჩეთის შესვლის წერტილის დასაშვებობის შესამოწმებლად მოთხოვნას აქვს შემდეგი ფორმა:
მეთოდი | URL |
მიიღეთ | /egain/chat/entrypoint/checkEligibility/id |
URL პარამეტრები
სახელი |
აღწერა | ტიპი | საჭირო | ნაგულისხმევი მნიშვნელობა არჩევითი პარამეტრები |
ID | შესვლის წერტილის ID, რომლის შემოწმებაც გსურთ. | გრძელი | დიახ |
სათაურების მოთხოვნა
არ გამოიყენება.
მოთხოვნის ორგანო
არ გამოიყენება.
XSD FOR RQUEST BODY
არ გამოიყენება.
SAMPმოითხოვეთ XML
არ გამოიყენება.
პასუხი
პასუხი მოიცავს HTTP სტატუსის კოდს და პასუხის ორგანოს.
სტატუსის კოდები
წარმატების კოდები:
- 200: შესვლის პუნქტის უფლებამოსილება დაბრუნდა. ეს იდენტიფიცირებულია ატრიბუტის answerType მნიშვნელობით. ამ ატრიბუტს შეიძლება ჰქონდეს რომელიმე შემდეგი მნიშვნელობა:
- 0: ამ შესვლის წერტილთან დაკავშირებულ რიგს შეუძლია ახალი ჩეთების მართვა.
- 1: არცერთი აგენტი არ არის ხელმისაწვდომი ახალ ჩატებზე სამუშაოდ.
- 2: რიგის მაქსიმალურმა სიღრმემ მიაღწია მოცემულ შესვლის წერტილთან ასოცირებულ რიგში და ახალი ჩეთები არ დამუშავდება.
- 3: ინტეგრირებული აგენტის CTL მიღწეულია.
შეცდომის კოდები:
- 500: ჩეთის შესვლის წერტილის უფლებამოსილების მოძიება შეუძლებელია.
პასუხის სათაურები
არ გამოიყენება.
საპასუხო ორგანო
გამომავალი გენერირებულია XML ფორმატში.
HTTP/1.1 200 OK
<checkEligibility xmlns: ns2=”http://bindings.egain.com/chat“
xmlns: ns4=”urn:ietf: params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:client” xmlns: ns5=”http://jabber.org/protocol/httpbind”answerType=0 />
XSD პასუხის ორგანო
XML სქემა განისაზღვრება checkEligibility კვანძში eGainBosh.xsd-ში. file.
აჩვენეთ ჩატის ვარიანტი რიგის სიღრმეზე, აგენტის ხელმისაწვდომობაზე და შესვლის წერტილის სტატუსზე
ამოწმებს, შესაძლებელია თუ არა ახალი ჩეთების დამუშავება მოცემული ჩატის შესვლის წერტილის მიერ შემდეგი პირობების საფუძველზე:
- ჩატის შესვლის წერტილი აქტიურია.
- თუ არსებობს რაიმე აგენტი, რომელიც მუშაობს ახალ ჩეთის აქტივობებზე.
- თუ ამ შესვლის წერტილთან ასოცირებულმა რიგმა მიაღწია კონფიგურირებულ მაქსიმალურ სიღრმეს, ანუ რიგის მიერ დამუშავებული ჩეთების საერთო რაოდენობა უდრის ჩატების მაქსიმალურ რაოდენობას, რომელსაც რიგს შეუძლია დაამუშაოს დროის მოცემულ მომენტში.
გამოიყენეთ ეს API, რათა გადაწყვიტოთ ჩეთის ბმულის ჩვენება ან დამალვა webსაიტი ეფუძნება ჩატის შესვლის წერტილის მდგომარეობას, აგენტის ხელმისაწვდომობას და შეუძლია თუ არა მოცემულ შესვლის წერტილთან ასოცირებულ რიგს მეტი ჩატის მიღება.
მოთხოვნა
მოთხოვნას იმის შესამოწმებლად, შესაძლებელია თუ არა ახალი ჩეთების დამუშავება ჩატის შესვლის წერტილით, აქვს შემდეგი ფორმა:
მეთოდი | URL |
მიიღეთ | /egain/chat/entrypoint/chatAllowed/id |
URL პარამეტრები
სახელი | აღწერა | ტიპი | საჭირო | ნაგულისხმევი მნიშვნელობა არჩევითი პარამეტრები |
ID | შესვლის წერტილის ID, რომლის შემოწმებაც გსურთ. | გრძელი | დიახ |
სათაურების მოთხოვნა
არ გამოიყენება.
მოთხოვნის ორგანო
არ გამოიყენება.
XSD FOR RQUEST BODY
არ გამოიყენება.
SAMPმოითხოვეთ XML
არ გამოიყენება.
პასუხი
პასუხი მოიცავს HTTP სტატუსის კოდს და პასუხის ორგანოს.
სტატუსის კოდები
წარმატების კოდები:
- 200: თუ ახალი ჩეთები შეიძლება დამუშავდეს შესვლის წერტილით, დაბრუნდება. ეს იდენტიფიცირებულია დაშვებული ატრიბუტის მნიშვნელობით. ამ ატრიბუტს შეიძლება ჰქონდეს მნიშვნელობა true ან false. თუ ეს მართალია, ეს ნიშნავს, რომ ამ შესვლის პუნქტს შეუძლია ახალი ჩეთების მართვა. თუ ის ყალბია, ეს ნიშნავს, რომ ეს შესვლის წერტილი ვერ უმკლავდება ახალ ჩატებს. თუ მნიშვნელობა მცდარია, ატრიბუტის მიზეზი შეიძლება ჰქონდეს ქვემოთ ჩამოთვლილი მნიშვნელობებიდან ერთ-ერთი, რათა დაადგინოს მიზეზი, თუ მიუწვდომელია:
- queue_depth_reached: რიგის მაქსიმალურმა სიღრმემ მიაღწია მოცემულ შესვლის წერტილთან ასოცირებულ რიგში და ახალი ჩატი არ დამუშავდება.
- agent_not_available: არცერთი აგენტი არ არის ხელმისაწვდომი ახალ ჩატზე სამუშაოდ.
- service_not_running: აგენტის მინიჭების სერვისი არ მუშაობს.
- invalid_entry_point: მოთხოვნაში მიღებული შესვლის წერტილი არასწორია.
- entry_point_inactive: მოთხოვნაში მიღებული შესვლის წერტილი არ არის აქტიური.
- სხვა: ეს შესვლის წერტილი ვერ უმკლავდება ახალ ჩეთებს სხვა მიზეზების გამო.
შეცდომის კოდები:
- 500: ვერ მოიძებნა, შეუძლია თუ არა ამ შესვლის პუნქტს ახალი ჩეთების მართვა.
პასუხის სათაურები
არ გამოიყენება.
საპასუხო ორგანო
გამომავალი გენერირებულია XML ფორმატში.
HTTP/1.1 200 OK
<chatAllowed xmlns: ns1.0=”http://bindings.egain.com/chat”
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:client”
xmlns: ns5=”http://jabber.org/protocol/httpbind” allow=”true”/>
OR
HTTP/1.1 200 OK
<chatAllowed xmlns: ns2=”http://bindings.egain.com/chat“
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:client”
xmlns: ns5=”http://jabber.org/protocol/httpbind” დაშვებული = ”false” reason=”entry_point_inactive”/>
XSD პასუხის ორგანო
XML სქემა განსაზღვრულია chatAllowed კვანძში eGainBosh.xsd-ში file.
პირადი ჩატის გამოკითხვების გაგზავნა
ეს API შეიძლება გამოყენებულ იქნას ჩეთის სესიის ბოლოს ნაჩვენები პერსონალური გამოკითხვის ფორმების გასაგზავნად.
მოთხოვნა
მეთოდი | URL |
პოსტი | /egain/chat/entrypoint/გამოკითხვა |
URL პარამეტრები
არ გამოიყენება.
სათაურების მოთხოვნა
არ გამოიყენება.
მოთხოვნის ორგანო
მოთხოვნის ძირითადი ნაწილი უნდა იყოს XML ფორმატში. შემდეგი ცხრილი აღწერს საჭირო და არასავალდებულო ატრიბუტებს, რომლებიც შეიძლება გამოყენებულ იქნას გამოკითხვის წარდგენისთვის.
სახელი | აღწერა |
ტიპი |
საჭირო |
კითხვა | კითხვა, რომელიც არის მომხმარებლისთვის ნაჩვენები გამოკითხვის ნაწილი. | სიმებიანი | დიახ |
უპასუხე | პასუხი შესაბამის კითხვაზე. | სიმებიანი | დიახ |
XSD FOR RQUEST BODY
XML სქემა განსაზღვრულია eGainSurvey კვანძში eGainSurvey.xsd-ში. file.
SAMPმოითხოვეთ XML
<egainSurvey sid=”1000_d15c6659-3c4b-41df-b2b5-7bacb60df4ld” xmlns=”http://bindings.egain.com/chat"> კითხვა 1 პასუხი 1 კითხვა 2 პასუხი 2 კითხვა 3 პასუხი 3 კითხვა 4 პასუხი 4
პასუხი
პასუხი მოიცავს HTTP სტატუსის კოდს.
სტატუსის კოდები
წარმატების კოდები:
- 204: გამოკითხვა წარმატებით არის წარდგენილი.
პასუხის სათაურები
არ გამოიყენება.
საპასუხო ორგანო
არ გამოიყენება.
XSD პასუხის ორგანო
არ გამოიყენება.
Enterprise Chat and Email Developer's Guide to Web სერვისის API ჩეთისთვის
დოკუმენტები / რესურსები
![]() |
CISCO Enterprise Chat and Email Developer's Guide to Web სერვისი [pdf] მომხმარებლის სახელმძღვანელო Enterprise Chat and Email Developer s Guide to Web სერვისის, Enterprise Chat-ისა და ელფოსტის დეველოპერის სახელმძღვანელო Web სერვისი, დეველოპერის სახელმძღვანელო Web სერვისი, გზამკვლევი Web სერვისი, Web სერვისი |